Updating method return documentation.

Author: StephenHidem

AntPlus/DeviceProfiles/BicyclePower/Calibration.cs

@@ -140,6 +140,7 @@ internal void ParseMeasurementOutputData(byte[] dataPage)
         }
 
         /// <summary>Requests manual calibration.</summary>
+        /// <returns><see cref="MessagingReturnCode"/></returns>
         public async Task<MessagingReturnCode> RequestManualCalibration()
         {
             CalibrationStatus = CalibrationResponse.InProgress;
@@ -149,6 +150,7 @@ public async Task<MessagingReturnCode> RequestManualCalibration()
 
         /// <summary>Sets the sensor automatic zero configuration.</summary>
         /// <param name="autoZero">The automatic zero.</param>
+        /// <returns><see cref="MessagingReturnCode"/></returns>
         public async Task<MessagingReturnCode> SetAutoZeroConfiguration(AutoZero autoZero)
         {
             CalibrationStatus = CalibrationResponse.Unknown;
@@ -157,6 +159,7 @@ public async Task<MessagingReturnCode> SetAutoZeroConfiguration(AutoZero autoZer
         }
 
         /// <summary>Requests the manufacturer specific custom calibration parameters.</summary>
+        /// <returns><see cref="MessagingReturnCode"/></returns>
         public async Task<MessagingReturnCode> RequestCustomParameters()
         {
             CalibrationStatus = CalibrationResponse.InProgress;
@@ -167,6 +170,7 @@ public async Task<MessagingReturnCode> RequestCustomParameters()
         /// <summary>Sets the custom calibration parameters. This is manufacturer specified limited to a
         /// maximum of 6 bytes.</summary>
         /// <param name="customParameters">The custom parameters. Defined by the manufacturer.</param>
+        /// <returns><see cref="MessagingReturnCode"/></returns>
         /// <exception cref="System.ArgumentException">Custom parameters must be 6 bytes in length.</exception>
         public async Task<MessagingReturnCode> SetCustomParameters(byte[] customParameters)
         {

AntPlus/DeviceProfiles/BicyclePower/CrankTorqueFrequencySensor.cs

@@ -131,6 +131,7 @@ internal void ParseCalibrationMessage(byte[] message)
 
         /// <summary>Saves the slope to flash.</summary>
         /// <param name="slope">The slope. Valid range is 10.0 to 50.0 Nm/Hz. Resolution is 0.1 Nm/Hz.</param>
+        /// <returns><see cref="MessagingReturnCode"/></returns>
         /// <exception cref="ArgumentOutOfRangeException">Invalid slope value.</exception>
         public async Task<MessagingReturnCode> SaveSlopeToFlash(double slope)
         {
@@ -149,6 +150,7 @@ public async Task<MessagingReturnCode> SaveSlopeToFlash(double slope)
 
         /// <summary>Saves the serial number to flash.</summary>
         /// <param name="serialNumber">The serial number.</param>
+        /// <returns><see cref="MessagingReturnCode"/></returns>
         public async Task<MessagingReturnCode> SaveSerialNumberToFlash(ushort serialNumber)
         {
             byte[] msg = new byte[] { (byte)DataPage.Calibration, 0x10, (byte)CTFDefinedId.SerialNumber, 0xFF, 0xFF, 0xFF };

AntPlus/DeviceProfiles/FitnessEquipment/Equipment.cs

@@ -371,6 +371,7 @@ private void HandleFEState(byte state)
 
         /// <summary>Sets the percentage of maximum resistance resistance.</summary>
         /// <param name="resistance">The resistance.</param>
+        /// <returns><see cref="MessagingReturnCode"/></returns>
         public async Task<MessagingReturnCode> SetBasicResistance(double resistance)
         {
             byte[] res = new byte[] { (byte)(resistance / 0.5) };
@@ -381,6 +382,7 @@ public async Task<MessagingReturnCode> SetBasicResistance(double resistance)
 
         /// <summary>Sets the target power in wats.</summary>
         /// <param name="power">The power in watts. Resolution is 0.25 watt.</param>
+        /// <returns><see cref="MessagingReturnCode"/></returns>
         public async Task<MessagingReturnCode> SetTargetPower(double power)
         {
             byte[] pow = BitConverter.GetBytes((ushort)(power / 0.25));
@@ -393,6 +395,7 @@ public async Task<MessagingReturnCode> SetTargetPower(double power)
         /// <param name="windResistanceCoefficient">The wind resistance coefficient. Resolution is 0.01 kg/m.</param>
         /// <param name="windSpeed">The wind speed in km/h.</param>
         /// <param name="draftingFactor">The drafting scale factor. Range is 0 to 1.00.</param>
+        /// <returns><see cref="MessagingReturnCode"/></returns>
         public async Task<MessagingReturnCode> SetWindResistance(double windResistanceCoefficient, sbyte windSpeed, double draftingFactor)
         {
             byte[] wrc = new byte[] { (byte)(windResistanceCoefficient / 0.01) };
@@ -407,6 +410,7 @@ public async Task<MessagingReturnCode> SetWindResistance(double windResistanceCo
         /// <summary>Sets the track resistance.</summary>
         /// <param name="grade">The grade. Set as a percentage of vertical displacement to horizontal displacement.</param>
         /// <param name="rollingResistanceCoefficient">The rolling resistance coefficient.</param>
+        /// <returns><see cref="MessagingReturnCode"/></returns>
         public async Task<MessagingReturnCode> SetTrackResistance(double grade, double rollingResistanceCoefficient = 0.004)
         {
             byte[] grd = BitConverter.GetBytes((ushort)((grade + 200) / 0.01));
@@ -423,6 +427,7 @@ public async Task<MessagingReturnCode> SetTrackResistance(double grade, double r
         /// <param name="bikeWeight">The bike weight in kg.</param>
         /// <param name="wheelDiameter">The wheel diameter in meters.</param>
         /// <param name="gearRatio">The gear ratio.</param>
+        /// <returns><see cref="MessagingReturnCode"/></returns>
         public async Task<MessagingReturnCode> SetUserConfiguration(double userWeight, byte wheelDiameterOffset, double bikeWeight, double wheelDiameter, double gearRatio)
         {
             byte[] uw = BitConverter.GetBytes((ushort)(userWeight / 0.01));
@@ -439,6 +444,7 @@ public async Task<MessagingReturnCode> SetUserConfiguration(double userWeight, b
         }
 
         /// <summary>Requests the fitness equipment capabilities.</summary>
+        /// <returns><see cref="MessagingReturnCode"/></returns>
         public async Task<MessagingReturnCode> RequestFECapabilities()
         {
             return await RequestDataPage(DataPage.FECapabilities);

AntPlus/DeviceProfiles/HeartRate.cs

@@ -97,7 +97,7 @@ public enum HeartbeatEventType
         private bool isFirstDataMessage = true;     // used for accumulated values
         private byte prevBeatCount;
         private ushort prevBeatEventTime;
-        private int accumHeartBeatEventTime;
+        private int accumulatedHeartBeatEventTime;
         private bool pageToggle = false;
         private int observedToggle;
         private int rrInterval;
@@ -114,9 +114,9 @@ public readonly struct CommonHeartRateData
             /// <summary>RR interval in milliseconds.</summary>
             public int RRInterval { get; }
 
-            internal CommonHeartRateData(int accumEventTime, byte heartRate, int rrInterval)
+            internal CommonHeartRateData(int accumulatedEventTime, byte heartRate, int rrInterval)
             {
-                AccumulatedHeartBeatEventTime = accumEventTime * 1000 / 1024;
+                AccumulatedHeartBeatEventTime = accumulatedEventTime * 1000 / 1024;
                 ComputedHeartRate = heartRate;
                 RRInterval = rrInterval;
             }
@@ -293,7 +293,7 @@ public override void Parse(byte[] dataPage)
                 prevBeatEventTime = BitConverter.ToUInt16(dataPage, 4);
                 prevBeatCount = dataPage[6];
                 lastDataPage = dataPage;
-                HeartRateData = new CommonHeartRateData(accumHeartBeatEventTime, dataPage[7], rrInterval);
+                HeartRateData = new CommonHeartRateData(accumulatedHeartBeatEventTime, dataPage[7], rrInterval);
                 RaisePropertyChange(nameof(HeartRateData));
                 return;
             }
@@ -316,8 +316,8 @@ public override void Parse(byte[] dataPage)
                     rrInterval = CalculateRRInterval(prevBeatEventTime, BitConverter.ToUInt16(dataPage, 4));
                 }
 
-                accumHeartBeatEventTime += Utils.CalculateDelta(BitConverter.ToUInt16(dataPage, 4), ref prevBeatEventTime);
-                HeartRateData = new CommonHeartRateData(accumHeartBeatEventTime, dataPage[7], rrInterval);
+                accumulatedHeartBeatEventTime += Utils.CalculateDelta(BitConverter.ToUInt16(dataPage, 4), ref prevBeatEventTime);
+                HeartRateData = new CommonHeartRateData(accumulatedHeartBeatEventTime, dataPage[7], rrInterval);
                 RaisePropertyChange(nameof(HeartRateData));
             }
 
@@ -386,7 +386,8 @@ public override void Parse(byte[] dataPage)
         /// Sets the sport mode.
         /// </summary>
         /// <param name="sportMode">The sport mode.</param>
-        /// <param name="subSportMode">Subsport mode.</param>
+        /// <param name="subSportMode">The sub sport mode.</param>
+        /// <returns><see cref="MessagingReturnCode"/></returns>
         public async Task<MessagingReturnCode> SetSportMode(SportMode sportMode, SubSportMode subSportMode = SubSportMode.None)
         {
             return await SendExtAcknowledgedMessage(CommonDataPages.FormatModeSettingsPage(sportMode, subSportMode));
@@ -403,6 +404,7 @@ public async Task<MessagingReturnCode> SetSportMode(SportMode sportMode, SubSpor
         /// </remarks>
         /// <param name="applyGymMode">if set to <c>true</c> apply gym mode. Displays cannot rely on this field as older sensors do not decode it. The Gym Mode bit shall be set to the last received value from the capabilities page if Apply Gym Mode is set to false.</param>
         /// <param name="gymMode">if set to <c>true</c> gym mode is enabled.</param>
+        /// <returns><see cref="MessagingReturnCode"/></returns>
         public async Task<MessagingReturnCode> SetHRFeature(bool applyGymMode, bool gymMode)
         {
             byte[] msg = new byte[] { (byte)DataPage.HRFeature, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, (byte)(applyGymMode ? 0xFF : 0x7F), (byte)(gymMode ? 0x80 : 0x00) };