summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorYong He <yonghe@outlook.com>2022-11-10 09:44:00 -0800
committerGitHub <noreply@github.com>2022-11-10 09:44:00 -0800
commit610851abb4a88e59f8d23a3e3115e29e8cdf5601 (patch)
tree955b2e2e67c678c9655b51a988dc8f2c622f844e /docs
parent66b5351b26c242b1604fe81acd607a2c8144e463 (diff)
Fix document toc. (#2510)
Co-authored-by: Yong He <yhe@nvidia.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/scripts/Program.cs22
-rw-r--r--docs/user-guide/toc.html4
2 files changed, 23 insertions, 3 deletions
diff --git a/docs/scripts/Program.cs b/docs/scripts/Program.cs
index 8a7b6c1b6..d7f4ef623 100644
--- a/docs/scripts/Program.cs
+++ b/docs/scripts/Program.cs
@@ -95,7 +95,7 @@ namespace toc
}
const string shortTitlePrefix = "[//]: # (ShortTitle: ";
- public static string maybeGetShortTitle(string originalTitle, string[] lines, int line)
+ public static string maybeGetShortTitleImpl(string originalTitle, string[] lines, int line)
{
string nextLine = getNextNonEmptyLine(lines, line);
if (nextLine.StartsWith(shortTitlePrefix))
@@ -104,6 +104,26 @@ namespace toc
}
return originalTitle;
}
+
+ public static string escapeString(string input)
+ {
+ StringBuilder sb = new StringBuilder();
+ foreach (var ch in input)
+ {
+ if (ch == '<')
+ sb.Append("&lt;");
+ else if (ch == '>')
+ sb.Append("&gt;");
+ else
+ sb.Append(ch);
+ }
+ return sb.ToString();
+ }
+ public static string maybeGetShortTitle(string originalTitle, string[] lines, int line)
+ {
+ string title = maybeGetShortTitleImpl(originalTitle, lines, line);
+ return escapeString(title);
+ }
public static string Run(string path)
{
StringBuilder outputSB = new StringBuilder();
diff --git a/docs/user-guide/toc.html b/docs/user-guide/toc.html
index 5fdb4d0d0..e66677ef8 100644
--- a/docs/user-guide/toc.html
+++ b/docs/user-guide/toc.html
@@ -36,8 +36,8 @@
<li data-link="03-convenience-features#initializers"><span>Initializers</span></li>
<li data-link="03-convenience-features#operator-overloading"><span>Operator Overloading</span></li>
<li data-link="03-convenience-features#subscript-operator"><span>Subscript Operator</span></li>
-<li data-link="03-convenience-features#optionalt-type"><span>`Optional<T>` type</span></li>
-<li data-link="03-convenience-features#reinterprett-operation"><span>`reinterpret<T>` operation</span></li>
+<li data-link="03-convenience-features#optionalt-type"><span>`Optional&lt;T&gt;` type</span></li>
+<li data-link="03-convenience-features#reinterprett-operation"><span>`reinterpret&lt;T&gt;` operation</span></li>
<li data-link="03-convenience-features#struct-inheritance-limited"><span>`struct` inheritance (limited)</span></li>
<li data-link="03-convenience-features#extensions"><span>Extensions</span></li>
<li data-link="03-convenience-features#multi-level-break"><span>Multi-level break</span></li>