Skip to content

[clang-doc] Fix enum partial indentation #170196

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

Jump to bottom
Merged
evelez7 merged 3 commits into from
Dec 4, 2025
Merged

[clang-doc] Fix enum partial indentation #170196

evelez7 merged 3 commits into from
Dec 4, 2025

Conversation

@evelez7
Copy link
Member

@evelez7 evelez7 commented Dec 1, 2025

No description provided.

@evelez7 Graphite App
Copy link
Member Author

evelez7 commented Dec 1, 2025 •
edited
Loading

This stack of pull requests is managed by Graphite. Learn more about stacking.

This was referenced Dec 1, 2025
Merged
Merged
Merged
Open
@evelez7 evelez7 requested review from ilovepi and petrhosek December 1, 2025 19:58
@evelez7 evelez7 marked this pull request as ready for review December 1, 2025 19:58
@llvmbot
Copy link
Member

llvmbot commented Dec 1, 2025

@llvm/pr-subscribers-clang-tools-extra

Author: Erick Velez (evelez7)

Changes

Full diff: https://github.com/llvm/llvm-project/pull/170196.diff

3 Files Affected:

  • (modified) clang-tools-extra/clang-doc/assets/enum-template.mustache (+8-12)
  • (modified) clang-tools-extra/test/clang-doc/enum.cpp (+56-72)
  • (modified) clang-tools-extra/test/clang-doc/mustache-index.cpp (+8-12)
diff --git a/clang-tools-extra/clang-doc/assets/enum-template.mustache b/clang-tools-extra/clang-doc/assets/enum-template.mustache
index 53da4669d824b..ec42df99a7f4b 100644
--- a/clang-tools-extra/clang-doc/assets/enum-template.mustache
+++ b/clang-tools-extra/clang-doc/assets/enum-template.mustache
@@ -7,22 +7,18 @@
 }}
 <div id="{{ID}}" class="delimiter-container">
     <div>
-        <pre>
-            <code class="language-cpp code-clang-doc">
-enum {{Name}}
-            </code>
-        </pre>
+        <pre><code class="language-cpp code-clang-doc">enum {{Name}}</code></pre>
     </div>
     {{! Enum Values }}
     <table class="table-wrapper">
         <tbody>
-        <tr>
-            <th>Name</th>
-            <th>Value</th>
-            {{#HasComment}}
+            <tr>
+                <th>Name</th>
+                <th>Value</th>
+                {{#HasComment}}
                 <th>Comment</th>
-            {{/HasComment}}
-        </tr>
+                {{/HasComment}}
+            </tr>
             {{#Members}}
             <tr>
                 <td>{{Name}}</td>
@@ -34,7 +30,7 @@ enum {{Name}}
                 <td>{{ValueExpr}}</td>
                 {{/Value}}
                 {{#EnumValueComments}}
-                    <td>{{>Comments}}</td>
+                <td>{{>Comments}}</td>
                 {{/EnumValueComments}}
             </tr>
             {{/Members}}
diff --git a/clang-tools-extra/test/clang-doc/enum.cpp b/clang-tools-extra/test/clang-doc/enum.cpp
index ec4ddcaa82b32..ae13decac2e90 100644
--- a/clang-tools-extra/test/clang-doc/enum.cpp
+++ b/clang-tools-extra/test/clang-doc/enum.cpp
@@ -55,11 +55,7 @@ enum Color {
 // HTML-INDEX: <p> Comment 3</p>
 
 // MUSTACHE-INDEX:     <div>
-// MUSTACHE-INDEX:         <pre>
-// MUSTACHE-INDEX:             <code class="language-cpp code-clang-doc">
-// MUSTACHE-INDEX: enum Color
-// MUSTACHE-INDEX:             </code>
-// MUSTACHE-INDEX:         </pre>
+// MUSTACHE-INDEX:         <pre><code class="language-cpp code-clang-doc">enum Color</code></pre>
 // MUSTACHE-INDEX:     </div>
 // MUSTACHE-INDEX:     <table class="table-wrapper">
 // MUSTACHE-INDEX:         <tbody>
@@ -67,18 +63,18 @@ enum Color {
 // MUSTACHE-INDEX:                 <th>Name</th>
 // MUSTACHE-INDEX:                 <th>Value</th>
 // MUSTACHE-INDEX:             </tr>
-// MUSTACHE-INDEX:                 <tr>
-// MUSTACHE-INDEX:                     <td>Red</td>
-// MUSTACHE-INDEX:                     <td>0</td>
-// MUSTACHE-INDEX:                 </tr>
-// MUSTACHE-INDEX:                 <tr>
-// MUSTACHE-INDEX:                     <td>Green</td>
-// MUSTACHE-INDEX:                     <td>1</td>
-// MUSTACHE-INDEX:                 </tr>
-// MUSTACHE-INDEX:                 <tr>
-// MUSTACHE-INDEX:                     <td>Blue</td>
-// MUSTACHE-INDEX:                     <td>2</td>
-// MUSTACHE-INDEX:                 </tr>
+// MUSTACHE-INDEX:             <tr>
+// MUSTACHE-INDEX:                 <td>Red</td>
+// MUSTACHE-INDEX:                 <td>0</td>
+// MUSTACHE-INDEX:             </tr>
+// MUSTACHE-INDEX:             <tr>
+// MUSTACHE-INDEX:                 <td>Green</td>
+// MUSTACHE-INDEX:                 <td>1</td>
+// MUSTACHE-INDEX:             </tr>
+// MUSTACHE-INDEX:             <tr>
+// MUSTACHE-INDEX:                 <td>Blue</td>
+// MUSTACHE-INDEX:                 <td>2</td>
+// MUSTACHE-INDEX:             </tr>
 // MUSTACHE-INDEX:         </tbody>
 // MUSTACHE-INDEX:     </table>
 
@@ -117,11 +113,7 @@ enum class Shapes {
 
 // COM: FIXME: Serialize "enum class" in template
 // MUSTACHE-INDEX:     <div>
-// MUSTACHE-INDEX:         <pre>
-// MUSTACHE-INDEX:             <code class="language-cpp code-clang-doc">
-// MUSTACHE-INDEX: enum Shapes
-// MUSTACHE-INDEX:             </code>
-// MUSTACHE-INDEX:         </pre>
+// MUSTACHE-INDEX:         <pre><code class="language-cpp code-clang-doc">enum Shapes</code></pre>
 // MUSTACHE-INDEX:     </div>
 // MUSTACHE-INDEX:     <table class="table-wrapper">
 // MUSTACHE-INDEX:         <tbody>
@@ -129,18 +121,18 @@ enum class Shapes {
 // MUSTACHE-INDEX:                 <th>Name</th>
 // MUSTACHE-INDEX:                 <th>Value</th>
 // MUSTACHE-INDEX:             </tr>
-// MUSTACHE-INDEX:                 <tr>
-// MUSTACHE-INDEX:                     <td>Circle</td>
-// MUSTACHE-INDEX:                     <td>0</td>
-// MUSTACHE-INDEX:                 </tr>
-// MUSTACHE-INDEX:                 <tr>
-// MUSTACHE-INDEX:                     <td>Rectangle</td>
-// MUSTACHE-INDEX:                     <td>1</td>
-// MUSTACHE-INDEX:                 </tr>
-// MUSTACHE-INDEX:                 <tr>
-// MUSTACHE-INDEX:                     <td>Triangle</td>
-// MUSTACHE-INDEX:                     <td>2</td>
-// MUSTACHE-INDEX:                 </tr>
+// MUSTACHE-INDEX:             <tr>
+// MUSTACHE-INDEX:                 <td>Circle</td>
+// MUSTACHE-INDEX:                 <td>0</td>
+// MUSTACHE-INDEX:             </tr>
+// MUSTACHE-INDEX:             <tr>
+// MUSTACHE-INDEX:                 <td>Rectangle</td>
+// MUSTACHE-INDEX:                 <td>1</td>
+// MUSTACHE-INDEX:             </tr>
+// MUSTACHE-INDEX:             <tr>
+// MUSTACHE-INDEX:                 <td>Triangle</td>
+// MUSTACHE-INDEX:                 <td>2</td>
+// MUSTACHE-INDEX:             </tr>
 // MUSTACHE-INDEX:         </tbody>
 // MUSTACHE-INDEX:     </table>
 
@@ -240,11 +232,7 @@ enum Car {
 // HTML-VEHICLES: <p> Comment 4</p>
 
 // MUSTACHE-VEHICLES:     <div>
-// MUSTACHE-VEHICLES:         <pre>
-// MUSTACHE-VEHICLES:             <code class="language-cpp code-clang-doc">
-// MUSTACHE-VEHICLES: enum Car
-// MUSTACHE-VEHICLES:             </code>
-// MUSTACHE-VEHICLES:         </pre>
+// MUSTACHE-VEHICLES:         <pre><code class="language-cpp code-clang-doc">enum Car</code></pre>
 // MUSTACHE-VEHICLES:      </div>
 // MUSTACHE-VEHICLES:      <table class="table-wrapper">
 // MUSTACHE-VEHICLES:          <tbody>
@@ -252,22 +240,22 @@ enum Car {
 // MUSTACHE-VEHICLES:                  <th>Name</th>
 // MUSTACHE-VEHICLES:                  <th>Value</th>
 // MUSTACHE-VEHICLES:              </tr>
-// MUSTACHE-VEHICLES:                  <tr>
-// MUSTACHE-VEHICLES:                      <td>Sedan</td>
-// MUSTACHE-VEHICLES:                      <td>0</td>
-// MUSTACHE-VEHICLES:                  </tr>
-// MUSTACHE-VEHICLES:                  <tr>
-// MUSTACHE-VEHICLES:                      <td>SUV</td>
-// MUSTACHE-VEHICLES:                      <td>1</td>
-// MUSTACHE-VEHICLES:                  </tr>
-// MUSTACHE-VEHICLES:                  <tr>
-// MUSTACHE-VEHICLES:                      <td>Pickup</td>
-// MUSTACHE-VEHICLES:                      <td>2</td>
-// MUSTACHE-VEHICLES:                  </tr>
-// MUSTACHE-VEHICLES:                  <tr>
-// MUSTACHE-VEHICLES:                      <td>Hatchback</td>
-// MUSTACHE-VEHICLES:                      <td>3</td>
-// MUSTACHE-VEHICLES:                  </tr>
+// MUSTACHE-VEHICLES:              <tr>
+// MUSTACHE-VEHICLES:                  <td>Sedan</td>
+// MUSTACHE-VEHICLES:                  <td>0</td>
+// MUSTACHE-VEHICLES:              </tr>
+// MUSTACHE-VEHICLES:              <tr>
+// MUSTACHE-VEHICLES:                  <td>SUV</td>
+// MUSTACHE-VEHICLES:                  <td>1</td>
+// MUSTACHE-VEHICLES:              </tr>
+// MUSTACHE-VEHICLES:              <tr>
+// MUSTACHE-VEHICLES:                  <td>Pickup</td>
+// MUSTACHE-VEHICLES:                  <td>2</td>
+// MUSTACHE-VEHICLES:              </tr>
+// MUSTACHE-VEHICLES:              <tr>
+// MUSTACHE-VEHICLES:                  <td>Hatchback</td>
+// MUSTACHE-VEHICLES:                  <td>3</td>
+// MUSTACHE-VEHICLES:              </tr>
 // MUSTACHE-VEHICLES:          </tbody>
 // MUSTACHE-VEHICLES:      </table>
 
@@ -292,11 +280,7 @@ enum ColorUserSpecified {
 // HTML-INDEX: <td>&apos;C&apos;</td>
 
 // MUSTACHE-INDEX:     <div>
-// MUSTACHE-INDEX:         <pre>
-// MUSTACHE-INDEX:             <code class="language-cpp code-clang-doc">
-// MUSTACHE-INDEX: enum ColorUserSpecified
-// MUSTACHE-INDEX:             </code>
-// MUSTACHE-INDEX:         </pre>
+// MUSTACHE-INDEX:         <pre><code class="language-cpp code-clang-doc">enum ColorUserSpecified</code></pre>
 // MUSTACHE-INDEX:     </div>
 // MUSTACHE-INDEX:     <table class="table-wrapper">
 // MUSTACHE-INDEX:         <tbody>
@@ -304,17 +288,17 @@ enum ColorUserSpecified {
 // MUSTACHE-INDEX:                 <th>Name</th>
 // MUSTACHE-INDEX:                 <th>Value</th>
 // MUSTACHE-INDEX:             </tr>
-// MUSTACHE-INDEX:                 <tr>
-// MUSTACHE-INDEX:                     <td>RedUserSpecified</td>
-// MUSTACHE-INDEX:                     <td>&#39;A&#39;</td>
-// MUSTACHE-INDEX:                 </tr>
-// MUSTACHE-INDEX:                 <tr>
-// MUSTACHE-INDEX:                     <td>GreenUserSpecified</td>
-// MUSTACHE-INDEX:                     <td>2</td>
-// MUSTACHE-INDEX:                 </tr>
-// MUSTACHE-INDEX:                 <tr>
-// MUSTACHE-INDEX:                     <td>BlueUserSpecified</td>
-// MUSTACHE-INDEX:                     <td>&#39;C&#39;</td>
-// MUSTACHE-INDEX:                 </tr>
+// MUSTACHE-INDEX:             <tr>
+// MUSTACHE-INDEX:                 <td>RedUserSpecified</td>
+// MUSTACHE-INDEX:                 <td>&#39;A&#39;</td>
+// MUSTACHE-INDEX:             </tr>
+// MUSTACHE-INDEX:             <tr>
+// MUSTACHE-INDEX:                 <td>GreenUserSpecified</td>
+// MUSTACHE-INDEX:                 <td>2</td>
+// MUSTACHE-INDEX:             </tr>
+// MUSTACHE-INDEX:             <tr>
+// MUSTACHE-INDEX:                 <td>BlueUserSpecified</td>
+// MUSTACHE-INDEX:                 <td>&#39;C&#39;</td>
+// MUSTACHE-INDEX:             </tr>
 // MUSTACHE-INDEX:         </tbody>
 // MUSTACHE-INDEX:     </table>
\ No newline at end of file
diff --git a/clang-tools-extra/test/clang-doc/mustache-index.cpp b/clang-tools-extra/test/clang-doc/mustache-index.cpp
index 19e0b32d3d4af..709cc82bf85bb 100644
--- a/clang-tools-extra/test/clang-doc/mustache-index.cpp
+++ b/clang-tools-extra/test/clang-doc/mustache-index.cpp
@@ -34,30 +34,26 @@ class Foo;
 // CHECK-NEXT:      <div>
 // CHECK-NEXT:          <div id="{{[0-9A-F]*}}" class="delimiter-container">
 // CHECK-NEXT:              <div>
-// CHECK-NEXT:                  <pre>
-// CHECK-NEXT:                      <code class="language-cpp code-clang-doc">
-// CHECK-NEXT:                          enum Color
-// CHECK-NEXT:                      </code>
-// CHECK-NEXT:                  </pre>
+// CHECK-NEXT:                  <pre><code class="language-cpp code-clang-doc">enum Color</code></pre>
 // CHECK-NEXT:              </div>
 // CHECK-NEXT:              <table class="table-wrapper">
 // CHECK-NEXT:                  <tbody>
-// CHECK-NEXT:                  <tr>
-// CHECK-NEXT:                      <th>Name</th>
-// CHECK-NEXT:                      <th>Value</th>
-// CHECK:                       </tr>
+// CHECK-NEXT:                      <tr>
+// CHECK-NEXT:                          <th>Name</th>
+// CHECK-NEXT:                          <th>Value</th>
+// CHECK-NEXT:                      </tr>
 // CHECK-NEXT:                      <tr>
 // CHECK-NEXT:                          <td>RED</td>
 // CHECK-NEXT:                          <td>0</td>
-// CHECK:                           </tr>
+// CHECK-NEXT:                      </tr>
 // CHECK-NEXT:                      <tr>
 // CHECK-NEXT:                          <td>BLUE</td>
 // CHECK-NEXT:                          <td>1</td>
-// CHECK:                           </tr>
+// CHECK-NEXT:                      </tr>
 // CHECK-NEXT:                      <tr>
 // CHECK-NEXT:                          <td>GREEN</td>
 // CHECK-NEXT:                          <td>2</td>
-// CHECK:                           </tr>
+// CHECK-NEXT:                      </tr>
 // CHECK-NEXT:                  </tbody>
 // CHECK-NEXT:              </table>
 // CHECK-NEXT:              <div>

@evelez7 Graphite App
Copy link
Member Author

evelez7 commented Dec 1, 2025

Test HTML: https://erickvelez.com/clang-doc-mustache-output/enums/GlobalNamespace/

@evelez7 evelez7 force-pushed the users/evelez7/clang-doc-precommit-mustache-enum-tests branch from a8103e6 to 41503c8 Compare December 4, 2025 17:30
@evelez7 evelez7 force-pushed the users/evelez7/clang-doc-fix-enum-indentation branch from 6705300 to fdf9479 Compare December 4, 2025 17:30
Base automatically changed from users/evelez7/clang-doc-precommit-mustache-enum-tests to main December 4, 2025 17:33
@evelez7 evelez7 merged commit 55397cc into main Dec 4, 2025
5 of 9 checks passed
@evelez7 evelez7 deleted the users/evelez7/clang-doc-fix-enum-indentation branch December 4, 2025 17:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ilovepi ilovepi ilovepi approved these changes

@petrhosek petrhosek Awaiting requested review from petrhosek

Assignees

No one assigned

Labels

clang-tools-extra

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@evelez7 @llvmbot @ilovepi