Skip to content

Commit 0c5a7a5

Browse files
committedOct 5, 2024
Fix.
1 parent 2fa2809 commit 0c5a7a5

File tree

2 files changed

+25
-2
lines changed

2 files changed

+25
-2
lines changed
 

‎docs/build_reference.ps1

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Remove-Item -Path ".\stdlib-reference\types" -Recurse -Force
1414
cd stdlib-reference
1515
& ../../build/Release/bin/slangc -compile-stdlib -doc
1616
Move-Item -Path ".\toc.html" -Destination ".\_includes\stdlib-reference-toc.html" -Force
17+
git config user.email "bot@shader-slang.com"
18+
git config user.name "Stdlib Reference Bot"
1719
git add .
1820
git commit -m "Update stdlib reference"
1921
git push

‎source/slang/slang-doc-markdown-writer.cpp

+23-2
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,18 @@ void DocMarkdownWriter::_appendAsBullets(const List<NameAndText>& values, bool i
125125
if (insertLinkForName)
126126
out << translateToMarkdownWithLinks(name);
127127
else
128-
out << escapeMarkdownText(name);
128+
{
129+
auto spaceLoc = name.indexOf(' ');
130+
if (spaceLoc == -1)
131+
out << escapeMarkdownText(name);
132+
else
133+
{
134+
auto first = name.getUnownedSlice().head(spaceLoc);
135+
auto rest = name.getUnownedSlice().tail(spaceLoc + 1);
136+
out << escapeMarkdownText(first) << " ";
137+
out << translateToMarkdownWithLinks(rest);
138+
}
139+
}
129140
}
130141
}
131142

@@ -1838,6 +1849,7 @@ String DocMarkdownWriter::translateToMarkdownWithLinks(String text, bool strictC
18381849
case Slang::Misc::TokenType::OpLess:
18391850
case Slang::Misc::TokenType::OpGreater:
18401851
case Slang::Misc::TokenType::Comma:
1852+
case Slang::Misc::TokenType::Dot:
18411853
case Slang::Misc::TokenType::IntLiteral:
18421854
case Slang::Misc::TokenType::Semicolon:
18431855
requireSpaceBeforeNextToken = false;
@@ -1906,7 +1918,8 @@ String DocMarkdownWriter::translateToHTMLWithLinks(String text)
19061918
sb.append("\"");
19071919
if (isKeyword(token.Content.getUnownedSlice()))
19081920
sb.append(" class=\"code_keyword\"");
1909-
else if (as<AggTypeDeclBase>(page->getFirstEntry()->m_node) || as<TypeDefDecl>(page->getFirstEntry()->m_node))
1921+
else if (as<AggTypeDeclBase>(page->getFirstEntry()->m_node) ||
1922+
as<SimpleTypeDecl>(page->getFirstEntry()->m_node))
19101923
sb.append(" class=\"code_type\"");
19111924
sb.append(">");
19121925
escapeHTMLContent(sb, token.Content.getUnownedSlice());
@@ -1942,6 +1955,14 @@ String DocMarkdownWriter::translateToHTMLWithLinks(String text)
19421955
sb.append("</span>");
19431956
continue;
19441957
}
1958+
else if (token.Content == "This" ||
1959+
token.Content == "T")
1960+
{
1961+
sb.append("<span class=\"code_type\">");
1962+
escapeHTMLContent(sb, token.Content.getUnownedSlice());
1963+
sb.append("</span>");
1964+
continue;
1965+
}
19451966
}
19461967
escapeHTMLContent(sb, token.Content.getUnownedSlice());
19471968
if (token.Type == Slang::Misc::TokenType::Comma)

0 commit comments

Comments
 (0)