Skip to content

Commit 812b9be

Browse files
committed
Updated documentation, namespace summaries, and missing documentation for logger extensions.
1 parent 506fd73 commit 812b9be

File tree

902 files changed

+988
-926
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

902 files changed

+988
-926
lines changed

AntPlus/Extensions/Logging/LoggerExtensions.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ public static partial class LoggerExtensions
2626
/// </summary>
2727
/// <param name="logger">The logger instance.</param>
2828
/// <param name="dataPage">The data page as a byte array.</param>
29+
/// <param name="methodName">Optional: The caller member name.</param>
2930
public static void LogUnknownDataPage(this ILogger logger, byte[] dataPage, [CallerMemberName] string methodName = "")
3031
{
3132
s_unknownDataPage(logger, methodName, dataPage[0], BitConverter.ToString(dataPage));
@@ -41,6 +42,7 @@ public static void LogUnknownDataPage(this ILogger logger, byte[] dataPage, [Cal
4142
/// <param name="logger">The logger instance.</param>
4243
/// <param name="value">The value in the data page that is not defined in the enumeration.</param>
4344
/// <param name="dataPage">The data page as a byte array.</param>
45+
/// <param name="methodName">Optional: The caller member name.</param>
4446
public static void LogUnknownDataPage<TEnum>(this ILogger logger, byte value, byte[] dataPage, [CallerMemberName] string methodName = "") where TEnum : Enum
4547
{
4648
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
5557
/// <param name="logger">The logger instance.</param>
5658
/// <param name="channelIndex">The channel index.</param>
5759
/// <param name="channelId">The channel ID of the ANT device.</param>
60+
/// <param name="dataPage">The data page as a byte array.</param>
5861
/// <param name="result">A <see cref="MessagingReturnCode"/>. Set to null if not available.</param>
62+
/// <param name="methodName">Optional: The caller member name.</param>
5963
public static void LogSendAcknowledgedMessage(this ILogger logger, int channelIndex, uint channelId, byte[] dataPage, MessagingReturnCode? result, [CallerMemberName] string methodName = "")
6064
{
6165
if (result.HasValue)

Documentation/Documentation.shfbproj

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -60,23 +60,24 @@
6060
</PlugInConfigurations>
6161
<NamespaceSummaries>
6262
<NamespaceSummaryItem name="(global)" isDocumented="False" />
63-
<NamespaceSummaryItem name="SmallEarthTech.AntPlus" isDocumented="True">This is the global namespace for ANT+ devices.</NamespaceSummaryItem>
64-
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles (Group)" isGroup="True" isDocumented="True">This namespace contains supported ANT+ device profiles.</NamespaceSummaryItem>
65-
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.AssetTracker" isDocumented="True">Contains the asset tracker classes and members.</NamespaceSummaryItem>
66-
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.BicyclePower" isDocumented="True">Contains the bicycle power classes and members.</NamespaceSummaryItem>
67-
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.BikeSpeedAndCadence" isDocumented="True">Contains the bicycle speed and cadence classes and members.</NamespaceSummaryItem>
68-
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.FitnessEquipment" isDocumented="True">Contains the fitness equipment classes and members.</NamespaceSummaryItem>
69-
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.Geocache" isDocumented="False">Contains the geocache classes and members.</NamespaceSummaryItem>
70-
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.HeartRate" isDocumented="False">Contains the heart rate monitor classes and members.</NamespaceSummaryItem>
71-
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.MuscleOxygen" isDocumented="False">Contains the muscle oxygen sensor classes and members.</NamespaceSummaryItem>
72-
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.UnknownDevice" isDocumented="False">Contains the unknown ANT+ device classes and members.</NamespaceSummaryItem>
73-
<NamespaceSummaryItem name="SmallEarthTech.AntRadioInterface" isDocumented="True">The ANT+ radio interface namespace.</NamespaceSummaryItem>
74-
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.StrideBasedSpeedAndDistance" isDocumented="False">Contains the stride based speed and sensor classes and members.</NamespaceSummaryItem>
75-
<NamespaceSummaryItem name="SmallEarthTech.AntUsbStick" isDocumented="True">This namespace supports the concrete implementations of the ANT radio interface and ANT channel interface.</NamespaceSummaryItem>
76-
<NamespaceSummaryItem name="SmallEarthTech.AntPlus (Group)" isGroup="True" isDocumented="True">This group is the global namespace for ANT+ devices.</NamespaceSummaryItem>
77-
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles" isDocumented="True">This namespace contains supported ANT+ device profiles.</NamespaceSummaryItem>
78-
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.Extensions.Hosting" isDocumented="True">The ANT+ Hosting Extensions namespace.</NamespaceSummaryItem>
79-
</NamespaceSummaries>
63+
<NamespaceSummaryItem name="SmallEarthTech.AntPlus" isDocumented="True">This is the global namespace for ANT+ devices.</NamespaceSummaryItem>
64+
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles (Group)" isGroup="True" isDocumented="True">This namespace contains supported ANT+ device profiles.</NamespaceSummaryItem>
65+
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.AssetTracker" isDocumented="True">Contains the asset tracker classes and members.</NamespaceSummaryItem>
66+
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.BicyclePower" isDocumented="True">Contains the bicycle power classes and members.</NamespaceSummaryItem>
67+
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.BikeSpeedAndCadence" isDocumented="True">Contains the bicycle speed and cadence classes and members.</NamespaceSummaryItem>
68+
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.FitnessEquipment" isDocumented="True">Contains the fitness equipment classes and members.</NamespaceSummaryItem>
69+
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.Geocache" isDocumented="False">Contains the geocache classes and members.</NamespaceSummaryItem>
70+
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.HeartRate" isDocumented="False">Contains the heart rate monitor classes and members.</NamespaceSummaryItem>
71+
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.MuscleOxygen" isDocumented="False">Contains the muscle oxygen sensor classes and members.</NamespaceSummaryItem>
72+
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.UnknownDevice" isDocumented="False">Contains the unknown ANT+ device classes and members.</NamespaceSummaryItem>
73+
<NamespaceSummaryItem name="SmallEarthTech.AntRadioInterface" isDocumented="True">The ANT+ radio interface namespace.</NamespaceSummaryItem>
74+
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles.StrideBasedSpeedAndDistance" isDocumented="False">Contains the stride based speed and sensor classes and members.</NamespaceSummaryItem>
75+
<NamespaceSummaryItem name="SmallEarthTech.AntUsbStick" isDocumented="True">This namespace supports the concrete implementations of the ANT radio interface and ANT channel interface.</NamespaceSummaryItem>
76+
<NamespaceSummaryItem name="SmallEarthTech.AntPlus (Group)" isGroup="True" isDocumented="True">This group is the global namespace for ANT+ devices.</NamespaceSummaryItem>
77+
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles" isDocumented="True">This namespace contains supported ANT+ device profiles.</NamespaceSummaryItem>
78+
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.Extensions.Hosting" isDocumented="True">The ANT+ Hosting Extensions namespace.</NamespaceSummaryItem>
79+
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.Extensions (Group)" isGroup="True" isDocumented="True">This group is the global namespace for ANT+ extensions.</NamespaceSummaryItem>
80+
<NamespaceSummaryItem name="SmallEarthTech.AntPlus.Extensions.Logging" isDocumented="True">The ANT+ Logging Extensions namespace.</NamespaceSummaryItem></NamespaceSummaries>
8081
<VisibleItems>InheritedMembers, InheritedFrameworkMembers, Protected, ProtectedInternalAsProtected, NonBrowsable</VisibleItems>
8182
<ApiFilter>
8283
<Filter entryType="Namespace" fullName="CommunityToolkit.Mvvm.ComponentModel" isExposed="True" xmlns="">

docs/fti/FTI_100.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)