Updated documentation, namespace summaries, and missing documentation for logger extensions.

Author: StephenHidem

AntPlus/Extensions/Logging/LoggerExtensions.cs

@@ -26,6 +26,7 @@ public static partial class LoggerExtensions
         /// </summary>
         /// <param name="logger">The logger instance.</param>
         /// <param name="dataPage">The data page as a byte array.</param>
+        /// <param name="methodName">Optional: The caller member name.</param>
         public static void LogUnknownDataPage(this ILogger logger, byte[] dataPage, [CallerMemberName] string methodName = "")
         {
             s_unknownDataPage(logger, methodName, dataPage[0], BitConverter.ToString(dataPage));
@@ -41,6 +42,7 @@ public static void LogUnknownDataPage(this ILogger logger, byte[] dataPage, [Cal
         /// <param name="logger">The logger instance.</param>
         /// <param name="value">The value in the data page that is not defined in the enumeration.</param>
         /// <param name="dataPage">The data page as a byte array.</param>
+        /// <param name="methodName">Optional: The caller member name.</param>
         public static void LogUnknownDataPage<TEnum>(this ILogger logger, byte value, byte[] dataPage, [CallerMemberName] string methodName = "") where TEnum : Enum
         {
             s_unknownDataPageEnum(logger, methodName, dataPage[0], value, typeof(TEnum).Name, BitConverter.ToString(dataPage));
@@ -55,7 +57,9 @@ public static void LogUnknownDataPage<TEnum>(this ILogger logger, byte value, by
         /// <param name="logger">The logger instance.</param>
         /// <param name="channelIndex">The channel index.</param>
         /// <param name="channelId">The channel ID of the ANT device.</param>
+        /// <param name="dataPage">The data page as a byte array.</param>
         /// <param name="result">A <see cref="MessagingReturnCode"/>. Set to null if not available.</param>
+        /// <param name="methodName">Optional: The caller member name.</param>
         public static void LogSendAcknowledgedMessage(this ILogger logger, int channelIndex, uint channelId, byte[] dataPage, MessagingReturnCode? result, [CallerMemberName] string methodName = "")
         {
             if (result.HasValue)

Documentation/Documentation.shfbproj

@@ -60,23 +60,24 @@
     </PlugInConfigurations>
     <NamespaceSummaries>
       <NamespaceSummaryItem name="(global)" isDocumented="False" />
-      <NamespaceSummaryItem name="SmallEarthTech.AntPlus" isDocumented="True">This is the global namespace for ANT+ devices.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles (Group)" isGroup="True" isDocumented="True">This namespace contains supported ANT+ device profiles.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.AssetTracker" isDocumented="True">Contains the asset tracker classes and members.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.BicyclePower" isDocumented="True">Contains the bicycle power classes and members.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.BikeSpeedAndCadence" isDocumented="True">Contains the bicycle speed and cadence classes and members.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.FitnessEquipment" isDocumented="True">Contains the fitness equipment classes and members.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.Geocache" isDocumented="False">Contains the geocache classes and members.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.HeartRate" isDocumented="False">Contains the heart rate monitor classes and members.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.MuscleOxygen" isDocumented="False">Contains the muscle oxygen sensor classes and members.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.UnknownDevice" isDocumented="False">Contains the unknown ANT+ device classes and members.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="SmallEarthTech.AntRadioInterface" isDocumented="True">The ANT+ radio interface namespace.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.StrideBasedSpeedAndDistance" isDocumented="False">Contains the stride based speed and sensor classes and members.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="SmallEarthTech.AntUsbStick" isDocumented="True">This namespace supports the concrete implementations of the ANT radio interface and ANT channel interface.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="SmallEarthTech.AntPlus (Group)" isGroup="True" isDocumented="True">This group is the global namespace for ANT+ devices.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles" isDocumented="True">This namespace contains supported ANT+ device profiles.</NamespaceSummaryItem>
-      <NamespaceSummaryItem name="SmallEarthTech.AntPlus.Extensions.Hosting" isDocumented="True">The ANT+ Hosting Extensions namespace.</NamespaceSummaryItem>
-    </NamespaceSummaries>
+<NamespaceSummaryItem name="SmallEarthTech.AntPlus" isDocumented="True">This is the global namespace for ANT+ devices.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles (Group)" isGroup="True" isDocumented="True">This namespace contains supported ANT+ device profiles.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.AssetTracker" isDocumented="True">Contains the asset tracker classes and members.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.BicyclePower" isDocumented="True">Contains the bicycle power classes and members.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.BikeSpeedAndCadence" isDocumented="True">Contains the bicycle speed and cadence classes and members.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.FitnessEquipment" isDocumented="True">Contains the fitness equipment classes and members.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.Geocache" isDocumented="False">Contains the geocache classes and members.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.HeartRate" isDocumented="False">Contains the heart rate monitor classes and members.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.MuscleOxygen" isDocumented="False">Contains the muscle oxygen sensor classes and members.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.UnknownDevice" isDocumented="False">Contains the unknown ANT+ device classes and members.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="SmallEarthTech.AntRadioInterface" isDocumented="True">The ANT+ radio interface namespace.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.StrideBasedSpeedAndDistance" isDocumented="False">Contains the stride based speed and sensor classes and members.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="SmallEarthTech.AntUsbStick" isDocumented="True">This namespace supports the concrete implementations of the ANT radio interface and ANT channel interface.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="SmallEarthTech.AntPlus (Group)" isGroup="True" isDocumented="True">This group is the global namespace for ANT+ devices.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles" isDocumented="True">This namespace contains supported ANT+ device profiles.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="SmallEarthTech.AntPlus.Extensions.Hosting" isDocumented="True">The ANT+ Hosting Extensions namespace.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="SmallEarthTech.AntPlus.Extensions (Group)" isGroup="True" isDocumented="True">This group is the global namespace for ANT+ extensions.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="SmallEarthTech.AntPlus.Extensions.Logging" isDocumented="True">The ANT+ Logging Extensions namespace.</NamespaceSummaryItem></NamespaceSummaries>
     <VisibleItems>InheritedMembers, InheritedFrameworkMembers, Protected, ProtectedInternalAsProtected, NonBrowsable</VisibleItems>
     <ApiFilter>
       <Filter entryType="Namespace" fullName="CommunityToolkit.Mvvm.ComponentModel" isExposed="True" xmlns="">