Skip to content

Commit 0ff187d

Browse files
committed
Updated docs.
1 parent 01fc5ca commit 0ff187d

File tree

879 files changed

+977
-964
lines changed

Some content is hidden

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

879 files changed

+977
-964
lines changed

Documentation/Content/Unity/UnityGameDev.aml

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919

2020
<para>
2121
I've created a Unity example project to demonstrate integrating elements of the ANT+ class library and extensions.
22-
The repository is located
22+
The repository is located at
2323
<externalLink>
24-
<linkText>here.</linkText>
24+
<linkText>Unity ANT gRPC.</linkText>
2525
<linkUri>https://github.com/StephenHidem/Unity-ANT-gRPC</linkUri>
2626
</externalLink>
2727
The README contains important information!

Documentation/Content/VersionHistory/HostingExtensions/HostingExtensionsVersionHistory.aml

+6-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,12 @@
3030
<para>
3131
<link xlink:href="0677519c-d5ba-4c5d-b400-f10dc75a33a7" />
3232
</para>
33-
</listItem>
33+
</listItem>
34+
<listItem>
35+
<para>
36+
<link xlink:href="5c5fc223-4f8c-4a17-bb09-8f0d1d3f2cac" />
37+
</para>
38+
</listItem>
3439
</list>
3540
<!-- Uncomment this to create a sub-section outline
3641
<autoOutline /> -->
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<topic id="5c5fc223-4f8c-4a17-bb09-8f0d1d3f2cac" 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>Minor changes to AntCollection internals that create new ANT devices.</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+
27+
<relatedTopics>
28+
<link xlink:href="be2ad779-f723-47b4-a6ab-00691c896a8e" />
29+
<!-- One or more of the following:
30+
- A local link
31+
- An external link
32+
- A code entity reference
33+
34+
<link xlink:href="Other Topic's ID"/>
35+
<link xlink:href="Other Topic's ID">Link inner text</link>
36+
37+
<externalLink>
38+
<linkText>Link text</linkText>
39+
<linkAlternateText>Optional alternate link text</linkAlternateText>
40+
<linkUri>URI</linkUri>
41+
</externalLink>
42+
43+
<codeEntityReference>API member ID</codeEntityReference>
44+
45+
Examples:
46+
47+
<link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8270" />
48+
<link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8278">Some other topic</link>
49+
50+
<externalLink>
51+
<linkText>SHFB on GitHub</linkText>
52+
<linkAlternateText>Go to GitHub</linkAlternateText>
53+
<linkUri>https://GitHub.com/EWSoftware/SHFB</linkUri>
54+
</externalLink>
55+
56+
<codeEntityReference>T:TestDoc.TestClass</codeEntityReference>
57+
<codeEntityReference>P:TestDoc.TestClass.SomeProperty</codeEntityReference>
58+
<codeEntityReference>M:TestDoc.TestClass.#ctor</codeEntityReference>
59+
<codeEntityReference>M:TestDoc.TestClass.#ctor(System.String,System.Int32)</codeEntityReference>
60+
<codeEntityReference>M:TestDoc.TestClass.ToString</codeEntityReference>
61+
<codeEntityReference>M:TestDoc.TestClass.FirstMethod</codeEntityReference>
62+
<codeEntityReference>M:TestDoc.TestClass.SecondMethod(System.Int32,System.String)</codeEntityReference>
63+
-->
64+
</relatedTopics>
65+
</developerConceptualDocument>
66+
</topic>

Documentation/ContentLayout.content

+3-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
</HelpKeywords>
77
</Topic>
88
<Topic id="2c4b4d97-d5ec-44ef-846e-d8849c278fad" visible="True" title="AntRadioInterface Class Library Overview" />
9-
<Topic id="ec2cfcb5-62f1-4593-8295-b6b7cadab615" visible="True" isSelected="true" title="AntUsbStick Class Library Overview" />
9+
<Topic id="ec2cfcb5-62f1-4593-8295-b6b7cadab615" visible="True" title="AntUsbStick Class Library Overview" />
1010
<Topic id="fc7d6894-c2f6-45d3-8edb-8c82ab0bb422" visible="True" title="AntPlus Class Library Overview" />
1111
<Topic id="825ed94a-e668-4d28-85ff-53cbb962a355" visible="True" isExpanded="true" title="ANT+ Hosting Extensions Overview">
1212
<Topic id="0e424769-d4c6-4a98-9384-a810421ad5e1" visible="True" title="How-To: Create and Add a Custom AntDevice to Host" />
@@ -49,8 +49,9 @@
4949
<Topic id="c4f39db8-d602-4e2d-a75e-fc72afbc47c5" visible="True" title="Version 2.1.0.0" />
5050
<Topic id="ea422e45-03fe-4b1d-bc19-280e03ea4729" visible="True" title="Version 3.0.0.0" />
5151
</Topic>
52-
<Topic id="be2ad779-f723-47b4-a6ab-00691c896a8e" visible="True" title="Hosting Extensions Version History">
52+
<Topic id="be2ad779-f723-47b4-a6ab-00691c896a8e" visible="True" isExpanded="true" title="Hosting Extensions Version History">
5353
<Topic id="0677519c-d5ba-4c5d-b400-f10dc75a33a7" visible="True" title="Version 1.0.0.0" />
54+
<Topic id="5c5fc223-4f8c-4a17-bb09-8f0d1d3f2cac" visible="True" isSelected="true" title="Version 1.0.1.0" />
5455
</Topic>
5556
</Topic>
5657
</Topics>

Documentation/Documentation.shfbproj

+1
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,7 @@
151151
<None Include="Content\VersionHistory\AntUsbStick\v3.0.0.0.aml" />
152152
<None Include="Content\VersionHistory\HostingExtensions\HostingExtensionsVersionHistory.aml" />
153153
<None Include="Content\VersionHistory\HostingExtensions\v1.0.0.0.aml" />
154+
<None Include="Content\VersionHistory\HostingExtensions\v1.0.1.0.aml" />
154155
<None Include="Content\VersionHistory\VersionHistory.aml" />
155156
<None Include="Content\Welcome.aml" />
156157
</ItemGroup>

docs/SearchHelp.aspx

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
// System : Sandcastle Help File Builder
66
// File : SearchHelp.aspx
77
// Author : Eric Woodruff ([email protected])
8-
// Updated : 08/13/2022
9-
// Note : Copyright 2007-202, Eric Woodruff, All rights reserved
8+
// Updated : 08/02/2024
9+
// Note : Copyright 2007-2024, Eric Woodruff, All rights reserved
1010
//
1111
// This file contains the code used to search for keywords within the help topics using the full-text index
1212
// files created by the help file builder.
@@ -119,7 +119,7 @@ private List<string> ParseKeywords(string keywords)
119119
{
120120
checkWord = word.ToLower(CultureInfo.InvariantCulture);
121121
122-
if(checkWord.Length >= 2 && !Char.IsDigit(checkWord[0]) && !keywordList.Contains(checkWord))
122+
if(checkWord.Length >= 2 && !keywordList.Contains(checkWord))
123123
keywordList.Add(checkWord);
124124
}
125125

docs/SearchHelp.inc.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ function ParseKeywords($keywords)
2929
foreach($words as $word)
3030
{
3131
$checkWord = strtolower($word);
32-
$first = substr($checkWord, 0, 1);
33-
if(strlen($checkWord) >= 2 && !ctype_digit($first) && !in_array($checkWord, $keywordList))
32+
33+
if(strlen($checkWord) >= 2 && !in_array($checkWord, $keywordList))
3434
{
3535
array_push($keywordList, $checkWord);
3636
}

docs/fti/FTI_100.json

+1-1
Large diffs are not rendered by default.

docs/fti/FTI_101.json

+1-1
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)