Updates to NuGet version numbers and release notes.

StephenHidem · Jan 4, 2024 · c43e451 · c43e451
1 parent 7448885
commit c43e451
Show file tree

Hide file tree

Showing 884 changed files with 978 additions and 989 deletions.
diff --git a/AntPlus/AntPlus.csproj b/AntPlus/AntPlus.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-	<AssemblyVersion>3.0.0.0</AssemblyVersion>
+	<AssemblyVersion>3.0.1.0</AssemblyVersion>
     <TargetFramework>netstandard2.0</TargetFramework>
     <GenerateDocumentationFile>True</GenerateDocumentationFile>
     <RootNamespace>SmallEarthTech.$(MSBuildProjectName.Replace(" ", "_"))</RootNamespace>
@@ -24,12 +24,7 @@
 	<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
 	<PackageIcon>PackageLogo.png</PackageIcon>
 	<PackageReadmeFile>readme.md</PackageReadmeFile>
-	<PackageReleaseNotes>1. CommonSpeedCadence - bug fix handling default data page 0.
-2. Treadmill - added None to CapabilityFlags enum.
-3. AntDevice - fixed log warning bug in SendExtAcknowledgedMessage method.
-4. AntDeviceCollection - ctor has been modified.
-5. BicyclePower/Parameters - all methods are now async calls.
-6. Tracker - the asset is removed from the Assets collection if the Asset.AssetStatus.RemoveAsset flag is set.</PackageReleaseNotes>
+	<PackageReleaseNotes>Docunemtaion updates.</PackageReleaseNotes>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(GITHUB_ACTIONS)' == 'true'">

diff --git a/AntPlus/DeviceProfiles/BicyclePower/Parameters.cs b/AntPlus/DeviceProfiles/BicyclePower/Parameters.cs
@@ -278,10 +278,9 @@ public void Parse(byte[] dataPage)
             }
         }
 
-        /// <summary>
-        /// Gets the requested parameters subpage.
-        /// </summary>
+        /// <summary>Gets the requested parameters subpage.</summary>
         /// <param name="parameterSubpage">The parameter subpage.</param>
+        /// <returns><see cref="MessagingReturnCode"/></returns>
         public async Task<MessagingReturnCode> GetParameters(Subpage parameterSubpage)
         {
             return await _bicycle.RequestDataPage(DataPage.GetSetParameters, 500, (byte)parameterSubpage);
@@ -292,6 +291,7 @@ public async Task<MessagingReturnCode> GetParameters(Subpage parameterSubpage)
         /// 236.5 mm, auto crank length is enabled. Typically you would omit the length parameter to enable auto crank length.
         /// </summary>
         /// <param name="length">The length in millimeters. Omit to enable auto crank length.</param>
+        /// <returns><see cref="MessagingReturnCode"/></returns>
         public async Task<MessagingReturnCode> SetCrankLength(double length = 237)
         {
             byte[] msg;
@@ -318,6 +318,7 @@ public async Task<MessagingReturnCode> SetCrankLength(double length = 237)
         /// whether the transition was successful or not.
         /// </remarks>
         /// <param name="offset">The offset in seconds.</param>
+        /// <returns><see cref="MessagingReturnCode"/></returns>
         public async Task<MessagingReturnCode> SetTransitionTimeOffset(byte offset)
         {
             byte[] msg = new byte[] { (byte)DataPage.GetSetParameters, (byte)Subpage.RiderPositionConfiguration, offset, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
@@ -334,6 +335,7 @@ public async Task<MessagingReturnCode> SetTransitionTimeOffset(byte offset)
         /// </remarks>
         /// <param name="threshold">The threshold percentage.</param>
         /// <exception cref="System.ArgumentOutOfRangeException">Parameter threshold range is 0 to 100 percent.</exception>
+        /// <returns><see cref="MessagingReturnCode"/></returns>
         public async Task<MessagingReturnCode> SetPeakTorqueThreshold(double threshold)
         {
             // valid range is 0 to 100 percent

diff --git a/AntPlus/readme.md b/AntPlus/readme.md
@@ -13,5 +13,7 @@ Add a reference to this class in your application to interact with ANT+ devices
 Unknown devices are supported by the UnknownDevice class.
 ##### Addtional Links
 * [Documentation](https://stephenhidem.github.io/AntPlus/html/40537603-f0ed-f134-8e97-bd58d1d8b17d.htm)
+* [Examples](https://github.com/StephenHidem/AntPlus/tree/master/Examples) - See MAUI-gRPC and WpfUsbStickApp examples.
 * [Issues](https://github.com/StephenHidem/AntPlus/issues) - Mention AntPlus class library in the issue title.
+* [Discussions](https://github.com/StephenHidem/AntPlus/discussions) - Post questions and join discussions.
 
diff --git a/AntRadioInterface/AntRadioInterface.csproj b/AntRadioInterface/AntRadioInterface.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-	<AssemblyVersion>2.0.0.0</AssemblyVersion>
+	<AssemblyVersion>2.0.1.0</AssemblyVersion>
 	<TargetFramework>netstandard2.0</TargetFramework>
     <RootNamespace>SmallEarthTech.$(MSBuildProjectName.Replace(" ", "_"))</RootNamespace>
     <GenerateDocumentationFile>True</GenerateDocumentationFile>
@@ -23,7 +23,7 @@
     <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
     <PackageIcon>PackageLogo.png</PackageIcon>
     <PackageReadmeFile>readme.md</PackageReadmeFile>
-    <PackageReleaseNotes>IAntRadio - some interfaces have been changed to Task&lt;T&gt; return types. Others likely to follow in the future.</PackageReleaseNotes>
+    <PackageReleaseNotes>Docunentation updates.</PackageReleaseNotes>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(GITHUB_ACTIONS)' == 'true'">

diff --git a/AntRadioInterface/readme.md b/AntRadioInterface/readme.md
@@ -8,4 +8,6 @@ that supports the Dynastream/Garmin ANT USB stick.
 One important thing to note is this example uses the .NET and native DLLs provided in Dynastream's PC SDK.
 ##### Addtional Links
 * [Documentation](https://stephenhidem.github.io/AntPlus/html/e3aaa19e-2c22-c645-29dd-df0b206bf71f.htm)
+* [Examples](https://github.com/StephenHidem/AntPlus/tree/master/Examples) - See AntUsbStick for an example implementation.
 * [Issues](https://github.com/StephenHidem/AntPlus/issues) - Mention AntRadioInterface in the issue title.
+* [Discussions](https://github.com/StephenHidem/AntPlus/discussions) - Post questions and join discussions.
diff --git a/Documentation/Documentation.shfbproj b/Documentation/Documentation.shfbproj
@@ -60,7 +60,7 @@
     <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="False">This namespace contains supported ANT+ device profiles.</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>
@@ -72,7 +72,7 @@
 <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 implementation of the ANT radio interface.</NamespaceSummaryItem>
-<NamespaceSummaryItem name="SmallEarthTech.AntPlus (Group)" isGroup="True" isDocumented="False">This is the global namespace for ANT+ devices.</NamespaceSummaryItem>
+<NamespaceSummaryItem name="SmallEarthTech.AntPlus (Group)" isGroup="True" isDocumented="True">This is the global namespace for ANT+ devices.</NamespaceSummaryItem>
 <NamespaceSummaryItem name="SmallEarthTech.AntPlus.DeviceProfiles" isDocumented="True">This namespace contains supported ANT+ device profiles.</NamespaceSummaryItem></NamespaceSummaries>
   </PropertyGroup>
   <!-- There are no properties for these groups.  AnyCPU needs to appear in order for Visual Studio to perform

diff --git a/Examples/AntUsbStick/readme.md b/Examples/AntUsbStick/readme.md
@@ -21,4 +21,6 @@ This snippet makes use of the Small Earth Technology ANT+ Class Library AntDevic
 will provide logging services and the IAntRadio implementation provided by the ANT+ USB Stick Class Library to the AntDeviceCollection.
 ##### Addtional Links
 * [Documentation](https://stephenhidem.github.io/AntPlus/html/bf8a5d40-6d1a-6d79-a57f-fd17688d7682.htm)
+* [Examples](https://github.com/StephenHidem/AntPlus/tree/master/Examples) - Includes AntUsbStick source code
 * [Issues](https://github.com/StephenHidem/AntPlus/issues) - Mention AntUsbStick in the issue title.
+* [Discussions](https://github.com/StephenHidem/AntPlus/discussions) - Post questions and join discussions.
diff --git a/docs/fti/FTI_100.json b/docs/fti/FTI_100.json
diff --git a/docs/fti/FTI_101.json b/docs/fti/FTI_101.json