Skip to content

Commit 2882b91

Browse files
StephenHidemStephenHidem
committed
Documentation updated and NuGet packages updated.
1 parent 26e48e0 commit 2882b91

File tree

1,791 files changed

+5607
-4301
lines changed

Some content is hidden

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

1,791 files changed

+5607
-4301
lines changed

‎AntPlus/AntPlus.csproj

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<Project Sdk="Microsoft.NET.Sdk">
22

33
<PropertyGroup>
4-
<AssemblyVersion>3.0.2.0</AssemblyVersion>
4+
<AssemblyVersion>3.0.1.0</AssemblyVersion>
55
<TargetFramework>netstandard2.0</TargetFramework>
66
<GenerateDocumentationFile>True</GenerateDocumentationFile>
77
<RootNamespace>SmallEarthTech.$(MSBuildProjectName.Replace(" ", "_"))</RootNamespace>

‎Documentation/Content/ClassLibraries.aml

+107
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<topic id="968e34d3-7df5-4f2d-9ea6-9f1d0096d26c" revisionNumber="1">
3+
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
4+
<!--
5+
<summary>
6+
<para>Optional summary abstract</para>
7+
</summary>
8+
-->
9+
<introduction>
10+
<!-- Uncomment this to generate an outline of the section and sub-section
11+
titles. Specify a numeric value as the inner text to limit it to
12+
a specific number of sub-topics when creating the outline. Specify
13+
zero (0) to limit it to top-level sections only. -->
14+
<!-- <autoOutline /> -->
15+
<para>API documentation for the Small Earth Technology ANT+ classes.</para>
16+
</introduction>
17+
<!-- Add one or more top-level section elements. These are collapsible.
18+
If using <autoOutline />, add an address attribute to identify it
19+
and specify a title so that it can be jumped to with a hyperlink. -->
20+
<section address="Section1">
21+
<title>Class Libraries</title>
22+
<content>
23+
<!-- Uncomment this to create a sub-section outline
24+
<autoOutline /> -->
25+
<table>
26+
<row>
27+
<entry>
28+
<codeEntityReference qualifyHint="false">G:SmallEarthTech.AntPlus</codeEntityReference>
29+
</entry>
30+
<entry>
31+
<para>Classes that support various ANT+ devices.</para>
32+
</entry>
33+
</row>
34+
<row>
35+
<entry>
36+
<codeEntityReference qualifyHint="false">N:SmallEarthTech.AntRadioInterface</codeEntityReference>
37+
</entry>
38+
<entry>
39+
<para>Abstract classes defining an ANT radio and channel.</para>
40+
</entry>
41+
</row>
42+
<row>
43+
<entry>
44+
<codeEntityReference qualifyHint="false">N:SmallEarthTech.AntUsbStick</codeEntityReference>
45+
</entry>
46+
<entry>
47+
<para>Concrete implementation of the AntRadioInterface using Dynastream/Garmin ANT USB sticks.</para>
48+
</entry>
49+
</row>
50+
</table>
51+
</content>
52+
<!-- If a section contains a sections element, its content creates
53+
sub-sections. These are not collapsible.
54+
<sections>
55+
<section address="SubSection1">
56+
<title>Sub-section 1</title>
57+
<content>
58+
<para>Sub-section content.</para>
59+
</content>
60+
</section>
61+
<section address="SubSection2">
62+
<title>Sub-section 2</title>
63+
<content>
64+
<para>Sub-section content.</para>
65+
</content>
66+
</section>
67+
</sections> -->
68+
</section>
69+
<relatedTopics>
70+
<!-- One or more of the following:
71+
- A local link
72+
- An external link
73+
- A code entity reference
74+
75+
<link xlink:href="Other Topic's ID"/>
76+
<link xlink:href="Other Topic's ID">Link inner text</link>
77+
78+
<externalLink>
79+
<linkText>Link text</linkText>
80+
<linkAlternateText>Optional alternate link text</linkAlternateText>
81+
<linkUri>URI</linkUri>
82+
</externalLink>
83+
84+
<codeEntityReference>API member ID</codeEntityReference>
85+
86+
Examples:
87+
88+
<link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8270" />
89+
<link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8278">Some other topic</link>
90+
91+
<externalLink>
92+
<linkText>SHFB on GitHub</linkText>
93+
<linkAlternateText>Go to GitHub</linkAlternateText>
94+
<linkUri>https://GitHub.com/EWSoftware/SHFB</linkUri>
95+
</externalLink>
96+
97+
<codeEntityReference>T:TestDoc.TestClass</codeEntityReference>
98+
<codeEntityReference>P:TestDoc.TestClass.SomeProperty</codeEntityReference>
99+
<codeEntityReference>M:TestDoc.TestClass.#ctor</codeEntityReference>
100+
<codeEntityReference>M:TestDoc.TestClass.#ctor(System.String,System.Int32)</codeEntityReference>
101+
<codeEntityReference>M:TestDoc.TestClass.ToString</codeEntityReference>
102+
<codeEntityReference>M:TestDoc.TestClass.FirstMethod</codeEntityReference>
103+
<codeEntityReference>M:TestDoc.TestClass.SecondMethod(System.Int32,System.String)</codeEntityReference>
104+
-->
105+
</relatedTopics>
106+
</developerConceptualDocument>
107+
</topic>

‎Documentation/Content/Examples/AntMulticastServer.aml

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<topic id="7e5a578a-ecb8-4bf2-adf3-587b47e3c3ab" revisionNumber="1">
3+
<developerConceptualDocument
4+
xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5"
5+
xmlns:xlink="http://www.w3.org/1999/xlink">
6+
7+
<!--
8+
<summary>
9+
<para>Optional summary abstract</para>
10+
</summary>
11+
-->
12+
13+
<introduction>
14+
<!-- Uncomment this to generate an outline of the section and sub-section
15+
titles. Specify a numeric value as the inner text to limit it to
16+
a specific number of sub-topics when creating the outline. Specify
17+
zero (0) to limit it to top-level sections only. -->
18+
<!-- <autoOutline /> -->
19+
20+
<para>
21+
This project creates an IPv6 UdpClient bound to port number 2000. The UdpClient directs all messages received from the
22+
AntDeviceCollection to the multicast group [::] (all interfaces on the local subnet), port number 55436. A Xamarin
23+
client example (Android only) is available as a separate solution at
24+
<externalLink>
25+
<linkText>XamAntClientApp.</linkText>
26+
<linkUri>https://github.com/StephenHidem/XamAntClientApp/</linkUri>
27+
</externalLink>
28+
</para>
29+
<alert class="note">
30+
<para>
31+
This project uses the AntUsbSick project. Therefore, the platform target is set to x86. This is due to the native
32+
DLLs that are a part of this project. On the other hand, client apps that join the multicast group may set their
33+
platform target to any CPU.
34+
</para>
35+
</alert>
36+
<alert class="important">
37+
<para>Xamarin is being replaced with .NET MAUI. This project and the client example will no longer be updated or maintained.</para>
38+
</alert>
39+
</introduction>
40+
41+
<!-- Add one or more top-level section elements. These are collapsible.
42+
If using <autoOutline />, add an address attribute to identify it
43+
and specify a title so that it can be jumped to with a hyperlink. -->
44+
45+
<relatedTopics>
46+
<externalLink>
47+
<linkText>XamAntClientApp on GitHub</linkText>
48+
<linkUri>https://github.com/StephenHidem/XamAntClientApp/</linkUri>
49+
</externalLink>
50+
<!-- One or more of the following:
51+
- A local link
52+
- An external link
53+
- A code entity reference
54+
55+
<link xlink:href="Other Topic's ID"/>
56+
<link xlink:href="Other Topic's ID">Link inner text</link>
57+
58+
<externalLink>
59+
<linkText>Link text</linkText>
60+
<linkAlternateText>Optional alternate link text</linkAlternateText>
61+
<linkUri>URI</linkUri>
62+
</externalLink>
63+
64+
<codeEntityReference>API member ID</codeEntityReference>
65+
66+
Examples:
67+
68+
<link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8270" />
69+
<link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8278">Some other topic</link>
70+
71+
<externalLink>
72+
<linkText>SHFB on GitHub</linkText>
73+
<linkAlternateText>Go to GitHub</linkAlternateText>
74+
<linkUri>https://GitHub.com/EWSoftware/SHFB</linkUri>
75+
</externalLink>
76+
77+
<codeEntityReference>T:TestDoc.TestClass</codeEntityReference>
78+
<codeEntityReference>P:TestDoc.TestClass.SomeProperty</codeEntityReference>
79+
<codeEntityReference>M:TestDoc.TestClass.#ctor</codeEntityReference>
80+
<codeEntityReference>M:TestDoc.TestClass.#ctor(System.String,System.Int32)</codeEntityReference>
81+
<codeEntityReference>M:TestDoc.TestClass.ToString</codeEntityReference>
82+
<codeEntityReference>M:TestDoc.TestClass.FirstMethod</codeEntityReference>
83+
<codeEntityReference>M:TestDoc.TestClass.SecondMethod(System.Int32,System.String)</codeEntityReference>
84+
-->
85+
</relatedTopics>
86+
</developerConceptualDocument>
87+
</topic>

‎Documentation/Content/Examples/AntUsbStick.aml

+124
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<topic id="01001d50-9ea0-4e9c-a933-dbb67b7965cb" revisionNumber="1">
3+
<developerConceptualDocument
4+
xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5"
5+
xmlns:xlink="http://www.w3.org/1999/xlink">
6+
7+
<!--
8+
<summary>
9+
<para>Optional summary abstract</para>
10+
</summary>
11+
-->
12+
13+
<introduction>
14+
<!-- Uncomment this to generate an outline of the section and sub-section
15+
titles. Specify a numeric value as the inner text to limit it to
16+
a specific number of sub-topics when creating the outline. Specify
17+
zero (0) to limit it to top-level sections only. -->
18+
<!-- <autoOutline /> -->
19+
20+
<para>
21+
This example implements the Small Earth Technology ANT radio interface. It supports Garmin/Dynastream ANT USB sticks and some development
22+
boards with USB interfaces. It is also available on
23+
<externalLink>
24+
<linkText>NuGet.</linkText>
25+
<linkUri>https://www.nuget.org/packages/SmallEarthTech.AntUsbStick</linkUri>
26+
</externalLink>
27+
</para>
28+
<alert class="important">
29+
<para>Projects that consume this project must set the platform target to x86. This is due to the native DLLs that are a part of this project.</para>
30+
</alert>
31+
32+
<para>
33+
AntUsbStick provides two primary classes to consuming applications - AntRadio and AntChannel. AntRadio handles global
34+
ANT USB stick radio settings and operation. AntChannel handles individual channel configuration and communication with ANT devices.
35+
</para>
36+
</introduction>
37+
38+
<!-- Add one or more top-level section elements. These are collapsible.
39+
If using <autoOutline />, add an address attribute to identify it
40+
and specify a title so that it can be jumped to with a hyperlink. -->
41+
<section address="Section1">
42+
<content/>
43+
<!-- If a section contains a sections element, its content creates
44+
sub-sections. These are not collapsible. -->
45+
<sections>
46+
<section address="SubSection1">
47+
<title>AntRadio</title>
48+
<content>
49+
<para>
50+
AntRadio implements IAntRadio, IAntConfiguration, IAntControl, ICrypto, IFitSettings, and IAntUsbRadio
51+
interfaces. This is specific to Garmin/Dynastream ANT USB sticks.
52+
</para>
53+
</content>
54+
</section>
55+
<section address="SubSection2">
56+
<title>AntChannel</title>
57+
<content>
58+
<para>
59+
AntChannel implements the IAntChannel interface. This is specific to Garmin/Dynastream ANT USB sticks.
60+
</para>
61+
</content>
62+
</section>
63+
<section address="SubSection3">
64+
<title>UsbAntResponse</title>
65+
<content>
66+
<para>
67+
UsbAntResponse derives from AntResponse. It provides access to ANT response messages specific to Garmin/Dynastream ANT USB sticks.
68+
</para>
69+
</content>
70+
</section>
71+
<section address="SubSection4">
72+
<title>UsbDeviceCapabilities</title>
73+
<content>
74+
<para>
75+
UsbDeviceCapabilities derives from DeviceCapabilities. It provides access to ANT device capabilities specific to Garmin/Dynastream ANT USB sticks.
76+
</para>
77+
</content>
78+
</section>
79+
</sections>
80+
</section>
81+
82+
<relatedTopics>
83+
<codeEntityReference qualifyHint="false">T:SmallEarthTech.AntUsbStick.AntRadio</codeEntityReference>
84+
<codeEntityReference qualifyHint="false">T:SmallEarthTech.AntUsbStick.AntChannel</codeEntityReference>
85+
<codeEntityReference qualifyHint="false">T:SmallEarthTech.AntUsbStick.UsbAntResponse</codeEntityReference>
86+
<codeEntityReference qualifyHint="false">T:SmallEarthTech.AntUsbStick.UsbDeviceCapabilities</codeEntityReference>
87+
<!-- One or more of the following:
88+
- A local link
89+
- An external link
90+
- A code entity reference
91+
92+
<link xlink:href="Other Topic's ID"/>
93+
<link xlink:href="Other Topic's ID">Link inner text</link>
94+
95+
<externalLink>
96+
<linkText>Link text</linkText>
97+
<linkAlternateText>Optional alternate link text</linkAlternateText>
98+
<linkUri>URI</linkUri>
99+
</externalLink>
100+
101+
<codeEntityReference>API member ID</codeEntityReference>
102+
103+
Examples:
104+
105+
<link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8270" />
106+
<link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8278">Some other topic</link>
107+
108+
<externalLink>
109+
<linkText>SHFB on GitHub</linkText>
110+
<linkAlternateText>Go to GitHub</linkAlternateText>
111+
<linkUri>https://GitHub.com/EWSoftware/SHFB</linkUri>
112+
</externalLink>
113+
114+
<codeEntityReference>T:TestDoc.TestClass</codeEntityReference>
115+
<codeEntityReference>P:TestDoc.TestClass.SomeProperty</codeEntityReference>
116+
<codeEntityReference>M:TestDoc.TestClass.#ctor</codeEntityReference>
117+
<codeEntityReference>M:TestDoc.TestClass.#ctor(System.String,System.Int32)</codeEntityReference>
118+
<codeEntityReference>M:TestDoc.TestClass.ToString</codeEntityReference>
119+
<codeEntityReference>M:TestDoc.TestClass.FirstMethod</codeEntityReference>
120+
<codeEntityReference>M:TestDoc.TestClass.SecondMethod(System.Int32,System.String)</codeEntityReference>
121+
-->
122+
</relatedTopics>
123+
</developerConceptualDocument>
124+
</topic>

0 commit comments

Comments
 (0)