[llvm-branch-commits] [clang-tools-extra] [clang-doc] generate comments for functions (PR #150468)
Erick Velez via llvm-branch-commits
llvm-branch-commits at lists.llvm.org
Thu Jul 24 10:11:29 PDT 2025
https://github.com/evelez7 created https://github.com/llvm/llvm-project/pull/150468
Change the function partial to enable comments to be generated for
functions. This only enables the brief comments in the basic project.
>From 5d9ea9d21231e41a4dbb5717771850c28307834a Mon Sep 17 00:00:00 2001
From: Erick Velez <erickvelez7 at gmail.com>
Date: Fri, 18 Jul 2025 13:03:07 -0700
Subject: [PATCH] [clang-doc] generate comments for functions
Change the function partial to enable comments to be generated for
functions. This only enables the brief comments in the basic project.
---
.../assets/function-template.mustache | 4 +-
.../clang-doc/basic-project.mustache.test | 302 +++++++++---------
2 files changed, 153 insertions(+), 153 deletions(-)
diff --git a/clang-tools-extra/clang-doc/assets/function-template.mustache b/clang-tools-extra/clang-doc/assets/function-template.mustache
index 6683afa03ea43..2510a4de2cd68 100644
--- a/clang-tools-extra/clang-doc/assets/function-template.mustache
+++ b/clang-tools-extra/clang-doc/assets/function-template.mustache
@@ -14,10 +14,10 @@
</code>
</pre>
{{! Function Comments }}
- {{#FunctionComments}}
+ {{#Description}}
<div>
{{>Comments}}
</div>
- {{/FunctionComments}}
+ {{/Description}}
</div>
</div>
diff --git a/clang-tools-extra/test/clang-doc/basic-project.mustache.test b/clang-tools-extra/test/clang-doc/basic-project.mustache.test
index 7cc32b9d8f08a..4cf8bad32fd9d 100644
--- a/clang-tools-extra/test/clang-doc/basic-project.mustache.test
+++ b/clang-tools-extra/test/clang-doc/basic-project.mustache.test
@@ -83,17 +83,17 @@ HTML-SHAPE: <code class="language-cpp code-clang-doc">
HTML-SHAPE: double area ()
HTML-SHAPE: </code>
HTML-SHAPE: </pre>
-HTML-SHAPE-NOT: <div>
-HTML-SHAPE-NOT: <div>
-HTML-SHAPE-NOT: <p> Calculates the area of the shape.</p>
-HTML-SHAPE-NOT: </div>
-HTML-SHAPE-NOT: <div>
-HTML-SHAPE-NOT: <p></p>
-HTML-SHAPE-NOT: </div>
-HTML-SHAPE-NOT: <div>
-HTML-SHAPE-NOT: <p></p>
-HTML-SHAPE-NOT: </div>
-HTML-SHAPE-NOT: </div>
+HTML-SHAPE: <div>
+HTML-SHAPE: <div>
+HTML-SHAPE: <p> Calculates the area of the shape.</p>
+HTML-SHAPE: </div>
+HTML-SHAPE: <div>
+HTML-SHAPE: <p></p>
+HTML-SHAPE: </div>
+HTML-SHAPE: <div>
+HTML-SHAPE: <p></p>
+HTML-SHAPE: </div>
+HTML-SHAPE: </div>
HTML-SHAPE: </div>
HTML-SHAPE: </div>
HTML-SHAPE: <div class="delimiter-container">
@@ -103,17 +103,17 @@ HTML-SHAPE: <code class="language-cpp code-clang-doc">
HTML-SHAPE: double perimeter ()
HTML-SHAPE: </code>
HTML-SHAPE: </pre>
-HTML-SHAPE-NOT: <div>
-HTML-SHAPE-NOT: <div>
-HTML-SHAPE-NOT: <p> Calculates the perimeter of the shape.</p>
-HTML-SHAPE-NOT: </div>
-HTML-SHAPE-NOT: <div>
-HTML-SHAPE-NOT: <p></p>
-HTML-SHAPE-NOT: </div>
-HTML-SHAPE-NOT: <div>
-HTML-SHAPE-NOT: <p></p>
-HTML-SHAPE-NOT: </div>
-HTML-SHAPE-NOT: </div>
+HTML-SHAPE: <div>
+HTML-SHAPE: <div>
+HTML-SHAPE: <p> Calculates the perimeter of the shape.</p>
+HTML-SHAPE: </div>
+HTML-SHAPE: <div>
+HTML-SHAPE: <p></p>
+HTML-SHAPE: </div>
+HTML-SHAPE: <div>
+HTML-SHAPE: <p></p>
+HTML-SHAPE: </div>
+HTML-SHAPE: </div>
HTML-SHAPE: </div>
HTML-SHAPE: </div>
HTML-SHAPE: <div class="delimiter-container">
@@ -123,14 +123,14 @@ HTML-SHAPE: <code class="language-cpp code-clang-doc">
HTML-SHAPE: void ~Shape ()
HTML-SHAPE: </code>
HTML-SHAPE: </pre>
-HTML-SHAPE-NOT: <div>
-HTML-SHAPE-NOT: <div>
-HTML-SHAPE-NOT: <p> Virtual destructor.</p>
-HTML-SHAPE-NOT: </div>
-HTML-SHAPE-NOT: <div>
-HTML-SHAPE-NOT: <p></p>
-HTML-SHAPE-NOT: </div>
-HTML-SHAPE-NOT: </div>
+HTML-SHAPE: <div>
+HTML-SHAPE: <div>
+HTML-SHAPE: <p> Virtual destructor.</p>
+HTML-SHAPE: </div>
+HTML-SHAPE: <div>
+HTML-SHAPE: <p></p>
+HTML-SHAPE: </div>
+HTML-SHAPE: </div>
HTML-SHAPE: </div>
HTML-SHAPE: </div>
HTML-SHAPE: </div>
@@ -250,17 +250,17 @@ HTML-CALC: <code class="language-cpp code-clang-doc">
HTML-CALC: int add (int a, int b)
HTML-CALC: </code>
HTML-CALC: </pre>
-HTML-CALC-NOT: <div>
-HTML-CALC-NOT: <div>
-HTML-CALC-NOT: <p> Adds two integers.</p>
-HTML-CALC-NOT: </div>
-HTML-CALC-NOT: <div>
-HTML-CALC-NOT: <p></p>
-HTML-CALC-NOT: </div>
-HTML-CALC-NOT: <div>
-HTML-CALC-NOT: <p></p>
-HTML-CALC-NOT: </div>
-HTML-CALC-NOT: </div>
+HTML-CALC: <div>
+HTML-CALC: <div>
+HTML-CALC: <p> Adds two integers.</p>
+HTML-CALC: </div>
+HTML-CALC: <div>
+HTML-CALC: <p></p>
+HTML-CALC: </div>
+HTML-CALC: <div>
+HTML-CALC: <p></p>
+HTML-CALC: </div>
+HTML-CALC: </div>
HTML-CALC: </div>
HTML-CALC: </div>
HTML-CALC: <div class="delimiter-container">
@@ -270,17 +270,17 @@ HTML-CALC: <code class="language-cpp code-clang-doc">
HTML-CALC: int subtract (int a, int b)
HTML-CALC: </code>
HTML-CALC: </pre>
-HTML-CALC-NOT: <div>
-HTML-CALC-NOT: <div>
-HTML-CALC-NOT: <p> Subtracts the second integer from the first.</p>
-HTML-CALC-NOT: </div>
-HTML-CALC-NOT: <div>
-HTML-CALC-NOT: <p></p>
-HTML-CALC-NOT: </div>
-HTML-CALC-NOT: <div>
-HTML-CALC-NOT: <p></p>
-HTML-CALC-NOT: </div>
-HTML-CALC-NOT: </div>
+HTML-CALC: <div>
+HTML-CALC: <div>
+HTML-CALC: <p> Subtracts the second integer from the first.</p>
+HTML-CALC: </div>
+HTML-CALC: <div>
+HTML-CALC: <p></p>
+HTML-CALC: </div>
+HTML-CALC: <div>
+HTML-CALC: <p></p>
+HTML-CALC: </div>
+HTML-CALC: </div>
HTML-CALC: </div>
HTML-CALC: </div>
HTML-CALC: <div class="delimiter-container">
@@ -290,17 +290,17 @@ HTML-CALC: <code class="language-cpp code-clang-doc">
HTML-CALC: int multiply (int a, int b)
HTML-CALC: </code>
HTML-CALC: </pre>
-HTML-CALC-NOT: <div>
-HTML-CALC-NOT: <div>
-HTML-CALC-NOT: <p> Multiplies two integers.</p>
-HTML-CALC-NOT: </div>
-HTML-CALC-NOT: <div>
-HTML-CALC-NOT: <p></p>
-HTML-CALC-NOT: </div>
-HTML-CALC-NOT: <div>
-HTML-CALC-NOT: <p></p>
-HTML-CALC-NOT: </div>
-HTML-CALC-NOT: </div>
+HTML-CALC: <div>
+HTML-CALC: <div>
+HTML-CALC: <p> Multiplies two integers.</p>
+HTML-CALC: </div>
+HTML-CALC: <div>
+HTML-CALC: <p></p>
+HTML-CALC: </div>
+HTML-CALC: <div>
+HTML-CALC: <p></p>
+HTML-CALC: </div>
+HTML-CALC: </div>
HTML-CALC: </div>
HTML-CALC: </div>
HTML-CALC: <div class="delimiter-container">
@@ -310,17 +310,17 @@ HTML-CALC: <code class="language-cpp code-clang-doc">
HTML-CALC: double divide (int a, int b)
HTML-CALC: </code>
HTML-CALC: </pre>
-HTML-CALC-NOT: <div>
-HTML-CALC-NOT: <div>
-HTML-CALC-NOT: <p> Divides the first integer by the second.</p>
-HTML-CALC-NOT: </div>
-HTML-CALC-NOT: <div>
-HTML-CALC-NOT: <p></p>
-HTML-CALC-NOT: </div>
-HTML-CALC-NOT: <div>
-HTML-CALC-NOT: <p></p>
-HTML-CALC-NOT: </div>
-HTML-CALC-NOT: </div>
+HTML-CALC: <div>
+HTML-CALC: <div>
+HTML-CALC: <p> Divides the first integer by the second.</p>
+HTML-CALC: </div>
+HTML-CALC: <div>
+HTML-CALC: <p></p>
+HTML-CALC: </div>
+HTML-CALC: <div>
+HTML-CALC: <p></p>
+HTML-CALC: </div>
+HTML-CALC: </div>
HTML-CALC: </div>
HTML-CALC: </div>
HTML-CALC: <div class="delimiter-container">
@@ -330,17 +330,17 @@ HTML-CALC: <code class="language-cpp code-clang-doc">
HTML-CALC: int mod (int a, int b)
HTML-CALC: </code>
HTML-CALC: </pre>
-HTML-CALC-NOT: <div>
-HTML-CALC-NOT: <div>
-HTML-CALC-NOT: <p> Performs the mod operation on integers.</p>
-HTML-CALC-NOT: </div>
-HTML-CALC-NOT: <div>
-HTML-CALC-NOT: <p></p>
-HTML-CALC-NOT: </div>
-HTML-CALC-NOT: <div>
-HTML-CALC-NOT: <p></p>
-HTML-CALC-NOT: </div>
-HTML-CALC-NOT: </div>
+HTML-CALC: <div>
+HTML-CALC: <div>
+HTML-CALC: <p> Performs the mod operation on integers.</p>
+HTML-CALC: </div>
+HTML-CALC: <div>
+HTML-CALC: <p></p>
+HTML-CALC: </div>
+HTML-CALC: <div>
+HTML-CALC: <p></p>
+HTML-CALC: </div>
+HTML-CALC: </div>
HTML-CALC: </div>
HTML-CALC: </div>
HTML-CALC: </div>
@@ -429,17 +429,17 @@ HTML-RECTANGLE: <code class="language-cpp code-clang-doc">
HTML-RECTANGLE: void Rectangle (double width, double height)
HTML-RECTANGLE: </code>
HTML-RECTANGLE: </pre>
-HTML-RECTANGLE-NOT: <div>
-HTML-RECTANGLE-NOT: <div>
-HTML-RECTANGLE-NOT: <p> Constructs a new Rectangle object.</p>
-HTML-RECTANGLE-NOT: </div>
-HTML-RECTANGLE-NOT: <div>
-HTML-RECTANGLE-NOT: <p></p>
-HTML-RECTANGLE-NOT: </div>
-HTML-RECTANGLE-NOT: <div>
-HTML-RECTANGLE-NOT: <p></p>
-HTML-RECTANGLE-NOT: </div>
-HTML-RECTANGLE-NOT: </div>
+HTML-RECTANGLE: <div>
+HTML-RECTANGLE: <div>
+HTML-RECTANGLE: <p> Constructs a new Rectangle object.</p>
+HTML-RECTANGLE: </div>
+HTML-RECTANGLE: <div>
+HTML-RECTANGLE: <p></p>
+HTML-RECTANGLE: </div>
+HTML-RECTANGLE: <div>
+HTML-RECTANGLE: <p></p>
+HTML-RECTANGLE: </div>
+HTML-RECTANGLE: </div>
HTML-RECTANGLE: </div>
HTML-RECTANGLE: </div>
HTML-RECTANGLE: <div class="delimiter-container">
@@ -449,17 +449,17 @@ HTML-RECTANGLE: <code class="language-cpp code-clang-doc">
HTML-RECTANGLE: double area ()
HTML-RECTANGLE: </code>
HTML-RECTANGLE: </pre>
-HTML-RECTANGLE-NOT: <div>
-HTML-RECTANGLE-NOT: <div>
-HTML-RECTANGLE-NOT: <p> Calculates the area of the rectangle.</p>
-HTML-RECTANGLE-NOT: </div>
-HTML-RECTANGLE-NOT: <div>
-HTML-RECTANGLE-NOT: <p></p>
-HTML-RECTANGLE-NOT: </div>
-HTML-RECTANGLE-NOT: <div>
-HTML-RECTANGLE-NOT: <p></p>
-HTML-RECTANGLE-NOT: </div>
-HTML-RECTANGLE-NOT: </div>
+HTML-RECTANGLE: <div>
+HTML-RECTANGLE: <div>
+HTML-RECTANGLE: <p> Calculates the area of the rectangle.</p>
+HTML-RECTANGLE: </div>
+HTML-RECTANGLE: <div>
+HTML-RECTANGLE: <p></p>
+HTML-RECTANGLE: </div>
+HTML-RECTANGLE: <div>
+HTML-RECTANGLE: <p></p>
+HTML-RECTANGLE: </div>
+HTML-RECTANGLE: </div>
HTML-RECTANGLE: </div>
HTML-RECTANGLE: </div>
HTML-RECTANGLE: <div class="delimiter-container">
@@ -469,17 +469,17 @@ HTML-RECTANGLE: <code class="language-cpp code-clang-doc">
HTML-RECTANGLE: double perimeter ()
HTML-RECTANGLE: </code>
HTML-RECTANGLE: </pre>
-HTML-RECTANGLE-NOT: <div>
-HTML-RECTANGLE-NOT: <div>
-HTML-RECTANGLE-NOT: <p> Calculates the perimeter of the rectangle.</p>
-HTML-RECTANGLE-NOT: </div>
-HTML-RECTANGLE-NOT: <div>
-HTML-RECTANGLE-NOT: <p></p>
-HTML-RECTANGLE-NOT: </div>
-HTML-RECTANGLE-NOT: <div>
-HTML-RECTANGLE-NOT: <p></p>
-HTML-RECTANGLE-NOT: </div>
-HTML-RECTANGLE-NOT: </div>
+HTML-RECTANGLE: <div>
+HTML-RECTANGLE: <div>
+HTML-RECTANGLE: <p> Calculates the perimeter of the rectangle.</p>
+HTML-RECTANGLE: </div>
+HTML-RECTANGLE: <div>
+HTML-RECTANGLE: <p></p>
+HTML-RECTANGLE: </div>
+HTML-RECTANGLE: <div>
+HTML-RECTANGLE: <p></p>
+HTML-RECTANGLE: </div>
+HTML-RECTANGLE: </div>
HTML-RECTANGLE: </div>
HTML-RECTANGLE: </div>
HTML-RECTANGLE: </div>
@@ -568,17 +568,17 @@ HTML-CIRCLE: <code class="language-cpp code-clang-doc">
HTML-CIRCLE: void Circle (double radius)
HTML-CIRCLE: </code>
HTML-CIRCLE: </pre>
-HTML-CIRCLE-NOT: <div>
-HTML-CIRCLE-NOT: <div>
-HTML-CIRCLE-NOT: <p> Constructs a new Circle object.</p>
-HTML-CIRCLE-NOT: </div>
-HTML-CIRCLE-NOT: <div>
-HTML-CIRCLE-NOT: <p></p>
-HTML-CIRCLE-NOT: </div>
-HTML-CIRCLE-NOT: <div>
-HTML-CIRCLE-NOT: <p></p>
-HTML-CIRCLE-NOT: </div>
-HTML-CIRCLE-NOT: </div>
+HTML-CIRCLE: <div>
+HTML-CIRCLE: <div>
+HTML-CIRCLE: <p> Constructs a new Circle object.</p>
+HTML-CIRCLE: </div>
+HTML-CIRCLE: <div>
+HTML-CIRCLE: <p></p>
+HTML-CIRCLE: </div>
+HTML-CIRCLE: <div>
+HTML-CIRCLE: <p></p>
+HTML-CIRCLE: </div>
+HTML-CIRCLE: </div>
HTML-CIRCLE: </div>
HTML-CIRCLE: </div>
HTML-CIRCLE: <div class="delimiter-container">
@@ -588,17 +588,17 @@ HTML-CIRCLE: <code class="language-cpp code-clang-doc">
HTML-CIRCLE: double area ()
HTML-CIRCLE: </code>
HTML-CIRCLE: </pre>
-HTML-CIRCLE-NOT: <div>
-HTML-CIRCLE-NOT: <div>
-HTML-CIRCLE-NOT: <p> Calculates the area of the circle.</p>
-HTML-CIRCLE-NOT: </div>
-HTML-CIRCLE-NOT: <div>
-HTML-CIRCLE-NOT: <p></p>
-HTML-CIRCLE-NOT: </div>
-HTML-CIRCLE-NOT: <div>
-HTML-CIRCLE-NOT: <p></p>
-HTML-CIRCLE-NOT: </div>
-HTML-CIRCLE-NOT: </div>
+HTML-CIRCLE: <div>
+HTML-CIRCLE: <div>
+HTML-CIRCLE: <p> Calculates the area of the circle.</p>
+HTML-CIRCLE: </div>
+HTML-CIRCLE: <div>
+HTML-CIRCLE: <p></p>
+HTML-CIRCLE: </div>
+HTML-CIRCLE: <div>
+HTML-CIRCLE: <p></p>
+HTML-CIRCLE: </div>
+HTML-CIRCLE: </div>
HTML-CIRCLE: </div>
HTML-CIRCLE: </div>
HTML-CIRCLE: <div class="delimiter-container">
@@ -608,17 +608,17 @@ HTML-CIRCLE: <code class="language-cpp code-clang-doc">
HTML-CIRCLE: double perimeter ()
HTML-CIRCLE: </code>
HTML-CIRCLE: </pre>
-HTML-CIRCLE-NOT: <div>
-HTML-CIRCLE-NOT: <div>
-HTML-CIRCLE-NOT: <p> Calculates the perimeter of the circle.</p>
-HTML-CIRCLE-NOT: </div>
-HTML-CIRCLE-NOT: <div>
-HTML-CIRCLE-NOT: <p></p>
-HTML-CIRCLE-NOT: </div>
-HTML-CIRCLE-NOT: <div>
-HTML-CIRCLE-NOT: <p></p>
-HTML-CIRCLE-NOT: </div>
-HTML-CIRCLE-NOT: </div>
+HTML-CIRCLE: <div>
+HTML-CIRCLE: <div>
+HTML-CIRCLE: <p> Calculates the perimeter of the circle.</p>
+HTML-CIRCLE: </div>
+HTML-CIRCLE: <div>
+HTML-CIRCLE: <p></p>
+HTML-CIRCLE: </div>
+HTML-CIRCLE: <div>
+HTML-CIRCLE: <p></p>
+HTML-CIRCLE: </div>
+HTML-CIRCLE: </div>
HTML-CIRCLE: </div>
HTML-CIRCLE: </div>
HTML-CIRCLE: </div>
More information about the llvm-branch-commits
mailing list