Skip to content

Commit 680fec6

Browse files
StephenHidemStephenHidem
committed
Update documentation.
1 parent 1b4d736 commit 680fec6

File tree

6 files changed

+112
-4
lines changed

6 files changed

+112
-4
lines changed

‎AntRadioInterface/AntRadioInterface.csproj

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

33
<PropertyGroup>
4-
<AssemblyVersion>2.0.2.0</AssemblyVersion>
4+
<AssemblyVersion>2.1.0.0</AssemblyVersion>
55
<TargetFramework>netstandard2.0</TargetFramework>
66
<RootNamespace>SmallEarthTech.$(MSBuildProjectName.Replace(" ", "_"))</RootNamespace>
77
<GenerateDocumentationFile>True</GenerateDocumentationFile>
@@ -23,7 +23,7 @@
2323
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
2424
<PackageIcon>PackageLogo.png</PackageIcon>
2525
<PackageReadmeFile>readme.md</PackageReadmeFile>
26-
<PackageReleaseNotes>OpenedFrameType and OpenedPortType are unused and have been marked obsolete. They will be removed in the next release.</PackageReleaseNotes>
26+
<PackageReleaseNotes>OpenedFrameType and OpenedPortType have been removed in this release. The GetSerialString method in IAntUsbRadio is redundant and has been marked as obsolete.</PackageReleaseNotes>
2727
</PropertyGroup>
2828

2929
<PropertyGroup Condition="'$(GITHUB_ACTIONS)' == 'true'">

‎Documentation/Content/Examples/MAUI-gRPC/AntGrpcServicePackage.aml

+7
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,13 @@
2424
Enter the following command from the developer command line -
2525
<command>dotnet tool install --global wix</command>
2626
</para>
27+
<alert class="note" title="Release June 9, 2024 Update">
28+
<para>
29+
The package has been updated to use WiX Toolset v5.0.0. No more .xsl transforms to remove items from the installer; it's defined in the package.wxs file.
30+
You can update your WiX toolset installation from the developer command line -
31+
<command>dotnet tool update --global wix</command>
32+
</para>
33+
</alert>
2734
</introduction>
2835

2936
<!-- Add one or more top-level section elements. These are collapsible.

‎Documentation/Content/VersionHistory/AntRadioInterface/AntRadioInterfaceVersionHistory.aml

+5
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,11 @@
4141
<link xlink:href="0fc4ab24-c15f-4d96-b9e8-8e1fcf238eff" />
4242
</para>
4343
</listItem>
44+
<listItem>
45+
<para>
46+
<link xlink:href="c8d04cf3-0a23-44ea-a795-7a0e14dba774" />
47+
</para>
48+
</listItem>
4449
</list>
4550
</content>
4651
<!-- If a section contains a sections element, its content creates

‎Documentation/Content/VersionHistory/AntRadioInterface/v2.1.0.0.aml

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<topic id="c8d04cf3-0a23-44ea-a795-7a0e14dba774" 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>Version 2.1.0.0 was released on June 9, 2024.</para>
21+
</introduction>
22+
23+
<!-- Add one or more top-level section elements. These are collapsible.
24+
If using <autoOutline />, add an address attribute to identify it
25+
and specify a title so that it can be jumped to with a hyperlink. -->
26+
<section address="Section1">
27+
<content>
28+
<list class="bullet">
29+
<listItem>
30+
<para>OpenedFrameType and OpenedPortType have been removed in this release.</para>
31+
</listItem>
32+
<listItem>
33+
<para>The GetSerialString method in IAntUsbRadio is redundant and has been marked as obsolete.</para>
34+
</listItem>
35+
</list>
36+
</content>
37+
<!-- If a section contains a sections element, its content creates
38+
sub-sections. These are not collapsible.
39+
<sections>
40+
<section address="SubSection1">
41+
<title>Sub-section 1</title>
42+
<content>
43+
<para>Sub-section content.</para>
44+
</content>
45+
</section>
46+
<section address="SubSection2">
47+
<title>Sub-section 2</title>
48+
<content>
49+
<para>Sub-section content.</para>
50+
</content>
51+
</section>
52+
</sections> -->
53+
</section>
54+
55+
<relatedTopics>
56+
<link xlink:href="55b5d927-4d00-4e63-9f70-4f35a796c423" />
57+
<!-- One or more of the following:
58+
- A local link
59+
- An external link
60+
- A code entity reference
61+
62+
<link xlink:href="Other Topic's ID"/>
63+
<link xlink:href="Other Topic's ID">Link inner text</link>
64+
65+
<externalLink>
66+
<linkText>Link text</linkText>
67+
<linkAlternateText>Optional alternate link text</linkAlternateText>
68+
<linkUri>URI</linkUri>
69+
</externalLink>
70+
71+
<codeEntityReference>API member ID</codeEntityReference>
72+
73+
Examples:
74+
75+
<link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8270" />
76+
<link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8278">Some other topic</link>
77+
78+
<externalLink>
79+
<linkText>SHFB on GitHub</linkText>
80+
<linkAlternateText>Go to GitHub</linkAlternateText>
81+
<linkUri>https://GitHub.com/EWSoftware/SHFB</linkUri>
82+
</externalLink>
83+
84+
<codeEntityReference>T:TestDoc.TestClass</codeEntityReference>
85+
<codeEntityReference>P:TestDoc.TestClass.SomeProperty</codeEntityReference>
86+
<codeEntityReference>M:TestDoc.TestClass.#ctor</codeEntityReference>
87+
<codeEntityReference>M:TestDoc.TestClass.#ctor(System.String,System.Int32)</codeEntityReference>
88+
<codeEntityReference>M:TestDoc.TestClass.ToString</codeEntityReference>
89+
<codeEntityReference>M:TestDoc.TestClass.FirstMethod</codeEntityReference>
90+
<codeEntityReference>M:TestDoc.TestClass.SecondMethod(System.Int32,System.String)</codeEntityReference>
91+
-->
92+
</relatedTopics>
93+
</developerConceptualDocument>
94+
</topic>

‎Documentation/ContentLayout.content

+3-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<HelpKeyword index="K" term="Welcome" />
66
</HelpKeywords>
77
</Topic>
8-
<Topic id="ad0d881c-d17a-471a-a2b7-8464c87a3588" visible="True" noFile="true" title="Examples">
8+
<Topic id="ad0d881c-d17a-471a-a2b7-8464c87a3588" visible="True" noFile="true" isExpanded="true" title="Examples">
99
<Topic id="01001d50-9ea0-4e9c-a933-dbb67b7965cb" visible="True" />
1010
<Topic id="3879f5ad-87f2-4628-adef-bc78a4015241" visible="True" />
1111
<Topic id="7e5a578a-ecb8-4bf2-adf3-587b47e3c3ab" visible="True" />
@@ -31,6 +31,7 @@
3131
<Topic id="a5a81f24-5ac3-49e4-8a8a-37566ebd5286" visible="True" title="Version 2.0.0.0" />
3232
<Topic id="3bf26a39-5daa-482c-9718-d2bed1141b6c" visible="True" title="Version 2.0.1.0" />
3333
<Topic id="0fc4ab24-c15f-4d96-b9e8-8e1fcf238eff" visible="True" title="Version 2.0.2.0" />
34+
<Topic id="c8d04cf3-0a23-44ea-a795-7a0e14dba774" visible="True" isSelected="true" title="Version 2.1.0.0" />
3435
</Topic>
3536
<Topic id="c4caecfe-e2ea-4c87-b602-75d6b57aa70b" visible="True" isExpanded="true" title="AntPlus Version History">
3637
<Topic id="b3754de5-1d8d-422e-9071-12d290d4b14d" visible="True" title="Version 2.0.0.0" />
@@ -40,7 +41,7 @@
4041
<Topic id="5784e268-84d1-466a-aa3a-e0fb8085a4ff" visible="True" title="Version 3.0.1.0" />
4142
</Topic>
4243
<Topic id="62db1666-31ce-45bd-9331-b6c3762dcffe" visible="True" isExpanded="true" title="AntUsbStick Version History">
43-
<Topic id="91a9ea80-f3a3-427f-ae9d-a021d19f6f46" visible="True" isSelected="true" title="Version 2.0.2.0" />
44+
<Topic id="91a9ea80-f3a3-427f-ae9d-a021d19f6f46" visible="True" title="Version 2.0.2.0" />
4445
</Topic>
4546
</Topic>
4647
</Topics>

‎Documentation/Documentation.shfbproj

+1
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@
111111
<None Include="Content\VersionHistory\AntRadioInterface\v2.0.2.0.aml" />
112112
<None Include="Content\VersionHistory\AntRadioInterface\v2.0.1.0.aml" />
113113
<None Include="Content\VersionHistory\AntRadioInterface\v2.0.0.0.aml" />
114+
<None Include="Content\VersionHistory\AntRadioInterface\v2.1.0.0.aml" />
114115
<None Include="Content\VersionHistory\AntUsbStick\v2.0.2.0.aml" />
115116
<None Include="Content\VersionHistory\AntPlus\v3.0.0.0.aml" />
116117
<None Include="Content\VersionHistory\AntPlus\v2.2.0.0.aml" />

0 commit comments

Comments
 (0)