Skip to content

[clang-doc] Add variables to the namespace HTML template #175226

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

Merged
evelez7 merged 1 commit into from
Jan 12, 2026
Merged

[clang-doc] Add variables to the namespace HTML template #175226

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
4 changes: 3 additions & 1 deletion clang-tools-extra/clang-doc/JSONGenerator.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -755,8 +755,10 @@ static void serializeInfo(const NamespaceInfo &I, json::Object &Obj,
Obj["HasConcepts"] = true;
}

if (!I.Children.Variables.empty())
if (!I.Children.Variables.empty()) {
serializeArray(I.Children.Variables, Obj, "Variables", SerializeInfo);
Obj["HasVariables"] = true;
}

serializeCommonChildren(I.Children, Obj, RepositoryUrl, RepositoryLinePrefix);
}
Expand Down
31 changes: 31 additions & 0 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 @@ -113,6 +113,22 @@
</details>
</li>
{{/HasTypedefs}}
{{#HasVariables}}
<li>
<details open>
<summary class="sidebar-section">
<a class="sidebar-item" href="#Variables">Variables</a>
</summary>
<ul>
{{#Variables}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
</li>
{{/Variables}}
</ul>
</details>
</li>
{{/HasVariables}}
</ul>
</div>
<div class="resizer" id="resizer"></div>
Expand Down Expand Up @@ -193,6 +209,21 @@
{{/Typedefs}}
</section>
{{/HasTypedefs}}
{{#HasVariables}}
<section id="Variables" class="section-container">
<h2>Variables</h2>
<div>
{{#Variables}}
<div id="{{USR}}" class="delimiter-container">
<pre><code class="language-cpp code-clang-doc" >{{#IsStatic}}static {{/IsStatic}}{{Type.QualName}} {{Name}}</code></pre>
{{#Location}}
<p>Defined at line {{LineNumber}} of file {{^FileURL}}{{Filename}}{{/FileURL}}{{#FileURL}}<a href="{{FileURL}}">{{Filename}}</a>{{/FileURL}}</p>
{{/Location}}
</div>
{{/Variables}}
</div>
</section>
{{/HasVariables}}
</div>
</div>
</main>
Expand Down
20 changes: 16 additions & 4 deletions clang-tools-extra/test/clang-doc/json/namespace.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// RUN: rm -rf %t && mkdir -p %t
// RUN: clang-doc --output=%t --format=json --executor=standalone %s
// RUN: clang-doc --output=%t --format=html --executor=standalone %s
// RUN: FileCheck %s < %t/json/GlobalNamespace/index.json
// RUN: FileCheck %s < %t/html/GlobalNamespace/index.html -check-prefix=HTML-CHECK

class MyClass {};

Expand All @@ -27,7 +28,7 @@ typedef int MyTypedef;
// CHECK-NEXT: "InfoType": "enum",
// CHECK-NEXT: "Location": {
// CHECK-NEXT: "Filename": "{{.*}}namespace.cpp",
// CHECK-NEXT: "LineNumber": 14
// CHECK-NEXT: "LineNumber": 15
// CHECK-NEXT: },
// CHECK-NEXT: "Members": [
// CHECK-NEXT: {
Expand Down Expand Up @@ -81,6 +82,7 @@ typedef int MyTypedef;
// CHECK-NEXT: "HasNamespaces": true,
// CHECK-NEXT: "HasRecords": true,
// CHECK-NEXT: "HasTypedefs": true,
// CHECK-NEXT: "HasVariables": true,
// CHECK-NEXT: "InfoType": "namespace",
// CHECK-NEXT: "Name": "Global Namespace",
// CHECK-NEXT: "Namespaces": [
Expand Down Expand Up @@ -108,7 +110,7 @@ typedef int MyTypedef;
// CHECK-NEXT: "IsUsing": false,
// CHECK-NEXT: "Location": {
// CHECK-NEXT: "Filename": "{{.*}}namespace.cpp",
// CHECK-NEXT: "LineNumber": 20
// CHECK-NEXT: "LineNumber": 21
// CHECK-NEXT: },
// CHECK-NEXT: "Name": "MyTypedef",
// CHECK-NEXT: "TypeDeclaration": "",
Expand All @@ -130,7 +132,7 @@ typedef int MyTypedef;
// CHECK-NEXT: "IsStatic": true,
// CHECK-NEXT: "Location": {
// CHECK-NEXT: "Filename": "{{.*}}namespace.cpp",
// CHECK-NEXT: "LineNumber": 12
// CHECK-NEXT: "LineNumber": 13
// CHECK-NEXT: },
// CHECK-NEXT: "Name": "Global",
// CHECK-NEXT: "Type": {
Expand All @@ -144,3 +146,13 @@ typedef int MyTypedef;
// CHECK-NEXT: }
// CHECK-NEXT: ]
// CHECK-NEXT: }

// HTML-CHECK: <section id="Variables" class="section-container">
// HTML-CHECK-NEXT: <h2>Variables</h2>
// HTML-CHECK-NEXT: <div>
// HTML-CHECK-NEXT: <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
// HTML-CHECK-NEXT: <pre><code class="language-cpp code-clang-doc" >static int Global</code></pre>
// HTML-CHECK-NEXT: <p>Defined at line 13 of file {{.*}}namespace.cpp</p>
// HTML-CHECK-NEXT: </div>
// HTML-CHECK-NEXT: </div>
// HTML-CHECK-NEXT: </section>