https://github.com/evelez7 created https://github.com/llvm/llvm-project/pull/150467
None >From a46cb871aef66b791ab878e3e75df9a3276f611f Mon Sep 17 00:00:00 2001 From: Erick Velez <erickvel...@gmail.com> Date: Wed, 23 Jul 2025 10:16:42 -0700 Subject: [PATCH] [clang-doc] precommit test for function comments --- .../clang-doc/basic-project.mustache.test | 151 ++++++++++++++++++ 1 file changed, 151 insertions(+) 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 4fb38e2b32fcb..7cc32b9d8f08a 100644 --- a/clang-tools-extra/test/clang-doc/basic-project.mustache.test +++ b/clang-tools-extra/test/clang-doc/basic-project.mustache.test @@ -83,6 +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: <div class="delimiter-container"> @@ -92,6 +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: <div class="delimiter-container"> @@ -101,6 +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: </div> @@ -220,6 +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: <div class="delimiter-container"> @@ -229,6 +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: <div class="delimiter-container"> @@ -238,6 +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: <div class="delimiter-container"> @@ -247,6 +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: <div class="delimiter-container"> @@ -256,6 +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: </div> @@ -344,6 +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: <div class="delimiter-container"> @@ -353,6 +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: <div class="delimiter-container"> @@ -362,6 +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: </div> @@ -450,6 +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: <div class="delimiter-container"> @@ -459,6 +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: <div class="delimiter-container"> @@ -468,6 +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: </div> _______________________________________________ llvm-branch-commits mailing list llvm-branch-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-branch-commits
