Update Essentials Barometer API Docs (#11378)

* Update Essentials Barometer API Docs * Apply suggestions from code review Co-authored-by: E.Z. Hart <hartez@users.noreply.github.com> Co-authored-by: E.Z. Hart <hartez@users.noreply.github.com>
dotnet · Nov 17, 2022 · 6013f56 · 6013f56
1 parent 50f32fc
commit 6013f56
Show file tree

Hide file tree

Showing 5 changed files with 103 additions and 361 deletions.
diff --git a/src/Essentials/docs/Microsoft.Maui.Essentials/Barometer.xml b/src/Essentials/docs/Microsoft.Maui.Essentials/Barometer.xml
diff --git a/src/Essentials/docs/Microsoft.Maui.Essentials/BarometerChangedEventArgs.xml b/src/Essentials/docs/Microsoft.Maui.Essentials/BarometerChangedEventArgs.xml
diff --git a/src/Essentials/docs/Microsoft.Maui.Essentials/BarometerData.xml b/src/Essentials/docs/Microsoft.Maui.Essentials/BarometerData.xml
diff --git a/src/Essentials/src/Barometer/Barometer.android.cs b/src/Essentials/src/Barometer/Barometer.android.cs
@@ -37,11 +37,18 @@ void PlatformStop()
 
 	class BarometerListener : Java.Lang.Object, ISensorEventListener, IDisposable
 	{
+		/// <summary>
+		/// Initializes a new instance of the <see cref="BarometerListener"/> class.
+		/// </summary>
+		/// <param name="changeHandler">The handler that is invoked when a change in the barometer reading is detected.</param>
 		public BarometerListener(Action<BarometerData> changeHandler)
 		{
 			ChangeHandler = changeHandler;
 		}
 
+		/// <summary>
+		/// A reference to the action that invoked when a change in the barometer reading has been detected.
+		/// </summary>
 		public readonly Action<BarometerData> ChangeHandler;
 
 		void ISensorEventListener.OnAccuracyChanged(Sensor? sensor, SensorStatus accuracy)