Skip to content

[clang-doc] integrate JSON as the source for Mustache templates #149589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: users/evelez7/clang-doc-refactor-json-for-mustache
Choose a base branch
from
+173 −656
Open

[clang-doc] integrate JSON as the source for Mustache templates #149589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
487 changes: 78 additions & 409 deletions clang-tools-extra/clang-doc/HTMLMustacheGenerator.cpp
View file
Open in desktop

Large diffs are not rendered by default.

62 changes: 32 additions & 30 deletions clang-tools-extra/clang-doc/assets/class-template.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,20 +44,20 @@
<main>
<div class="container">
<div class="sidebar">
<h2>{{RecordType}} {{Name}}</h2>
<h2>{{TagType}} {{Name}}</h2>
<ul>
{{#PublicMembers}}
{{#HasPublicMembers}}
<li class="sidebar-section">
<a class="sidebar-item" href="#PublicMethods">Public Members</a>
<a class="sidebar-item" href="#PublicMembers">Public Members</a>
</li>
<ul>
{{#Obj}}
{{#PublicMembers}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{Name}}">{{Name}}</a>
</li>
{{/Obj}}
{{/PublicMembers}}
</ul>
{{/PublicMembers}}
{{/HasPublicMembers}}
{{#ProtectedMembers}}
<li class="sidebar-section">
<a class="sidebar-item" href="#PublicMethods">Protected Members</a>
Expand All @@ -70,18 +70,18 @@
{{/Obj}}
</ul>
{{/ProtectedMembers}}
{{#PublicFunction}}
{{#HasPublicFunctions}}
<li class="sidebar-section">
<a class="sidebar-item" href="#PublicMethods">Public Method</a>
</li>
<ul>
{{#Obj}}
{{#PublicFunctions}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{ID}}">{{Name}}</a>
<a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
</li>
{{/Obj}}
{{/PublicFunctions}}
</ul>
{{/PublicFunction}}
{{/HasPublicFunctions}}
{{#ProtectedFunction}}
<li class="sidebar-section">
<a class="sidebar-item" href="#ProtectedFunction">Protected Method</a>
Expand All @@ -101,7 +101,7 @@
<ul>
{{#Obj}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{ID}}">{{EnumName}}</a>
<a class="sidebar-item" href="#{{USR}}">{{EnumName}}</a>
</li>
{{/Obj}}
</ul>
Expand All @@ -127,33 +127,33 @@
<div class="content">
<section class="hero section-container">
<div class="hero__title">
<h1 class="hero__title-large">{{RecordType}} {{Name}}</h1>
<h1 class="hero__title-large">{{TagType}} {{Name}}</h1>
{{#RecordComments}}
<div class="hero__subtitle">
{{>Comments}}
</div>
{{/RecordComments}}
</div>
</section>
{{#PublicMembers}}
{{#HasPublicMembers}}
<section id="PublicMembers" class="section-container">
<h2>Public Members</h2>
<div>
{{#Obj}}
{{#PublicMembers}}
<div id="{{Name}}" class="delimiter-container">
<pre>
<code class="language-cpp code-clang-doc" >{{Type}} {{Name}}</code>
<code class="language-cpp code-clang-doc" >{{Type}} {{Name}}</code>
</pre>
{{#MemberComments}}
<div>
{{>Comments}}
</div>
{{/MemberComments}}
</div>
{{/Obj}}
{{/PublicMembers}}
</div>
</section>
{{/PublicMembers}}
{{/HasPublicMembers}}
{{#ProtectedMembers}}
<section id="ProtectedMembers" class="section-container">
<h2>Protected Members</h2>
Expand All @@ -173,26 +173,28 @@
</div>
</section>
{{/ProtectedMembers}}
{{#PublicFunction}}
{{#HasPublicFunctions}}
<section id="PublicMethods" class="section-container">
<h2>Public Methods</h2>
<div>
{{#Obj}}
{{#PublicFunctions}}
{{>FunctionPartial}}
{{/Obj}}
{{/PublicFunctions}}
</div>
</section>
{{/PublicFunction}}
{{#ProtectedFunction}}
<section id="ProtectedFunction" class="section-container">
<h2>Protected Methods</h2>
<div>
{{/PublicFunctions}}
{{#ProtectedFunction}}
<li class="sidebar-section">
<a class="sidebar-item" href="#ProtectedFunction">Protected Method</a>
</li>
<ul>
{{#Obj}}
{{>FunctionPartial}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{ID}}">{{Name}}</a>
</li>
{{/Obj}}
</div>
</section>
{{/ProtectedFunction}}
</ul>
{{/ProtectedFunction}}
{{#Enums}}
<section id="Enums" class="section-container">
<h2>Enumerations</h2>
Expand Down
12 changes: 9 additions & 3 deletions clang-tools-extra/clang-doc/assets/enum-template.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<div>
<pre>
<code class="language-cpp code-clang-doc">
{{EnumName}}
{{Name}}
</code>
</pre>
</div>
Expand All @@ -23,15 +23,21 @@
<th>Comment</th>
{{/HasComment}}
</tr>
{{#EnumValues}}
{{#Members}}
<tr>
<td>{{Name}}</td>
{{! A ValueExpr is an explicitly assigned enum value }}
{{#Value}}
<td>{{Value}}</td>
{{/Value}}
{{^Value}}
<td>{{ValueExpr}}</td>
{{/Value}}
{{#EnumValueComments}}
<td>{{>Comments}}</td>
{{/EnumValueComments}}
</tr>
{{/EnumValues}}
{{/Members}}
</tbody>
</table>
{{#EnumComments}}
Expand Down
2 changes: 1 addition & 1 deletion clang-tools-extra/clang-doc/assets/function-template.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
This file defines the template for functions/methods
}}
<div class="delimiter-container">
<div id="{{ID}}">
<div id="{{USR}}">
{{! Function Prototype }}
<pre>
<code class="language-cpp code-clang-doc">
Expand Down
45 changes: 25 additions & 20 deletions clang-tools-extra/clang-doc/assets/namespace-template.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,56 +46,61 @@
<div class="sidebar">
<h2>{{RecordType}} {{Name}}</h2>
<ul>
{{#Enums}}
{{#HasEnums}}
<li class="sidebar-section">
<a class="sidebar-item" href="#Enums">Enums</a>
</li>
<ul>
{{#Obj}}
{{#Enums}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{ID}}">{{EnumName}}</a>
<a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
</li>
{{/Obj}}
{{/Enums}}
</ul>
{{/Enums}}
{{#Record}}
{{/HasEnums}}
{{#HasRecords}}
<li class="sidebar-section">
<a class="sidebar-item" href="#Classes">Inner Classes</a>
</li>
<ul>
{{#Links}}
{{#Records}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{ID}}">{{Name}}</a>
<a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
</li>
{{/Links}}
{{/Records}}
</ul>
{{/Record}}
{{/HasRecrods}}
</ul>
</div>
<div class="resizer" id="resizer"></div>
<div class="content">
{{#Enums}}
{{#HasEnums}}
<section id="Enums" class="section-container">
<h2>Enumerations</h2>
<div>
{{#Obj}}
{{#Enums}}
{{>EnumPartial}}
{{/Obj}}
{{/Enums}}
</div>
</section>
{{/Enums}}
{{#Record}}
{{/HasEnums}}

{{#HasRecords}}
<section id="Classes" class="section-container">
<h2>Inner Classes</h2>
<ul class="class-container">
{{#Links}}
<li id="{{ID}}" style="max-height: 40px;">
<a href="{{Link}}"><pre><code class="language-cpp code-clang-doc" >class {{Name}}</code></pre></a>
{{#Records}}
<li id="{{USR}}" style="max-height: 40px;">
<a href="{{DocumentationFileName}}.html">
<pre>
<code class="language-cpp code-clang-doc">class {{Name}}</code>
</pre>
</a>
</li>
{{/Links}}
{{/Records}}
</ul>
{{/HasRecords}}
</section>
{{/Record}}
</div>
</div>
</main>
Expand Down
Loading
Loading