[clang-doc] Add protected methods to class template

[evelez7]

Protected method tags already existed in the class template, but they didn't conform to the current JSON scheme.

[evelez7]

• [clang-doc] Add variables to the namespace HTML template #175226
• [clang-doc] Serialize repository URL in Mustache templates #174914
• [clang-doc] Don't serialize non-existant locations in HTML #174887
• [clang-doc] Add protected methods to class template #174884 👈 (View in Graphite)
• [clang-doc] Add protected members to class template #174883
• main

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

[llvmbot]

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

Author: Erick Velez (evelez7)

Changes

Protected method tags already existed in the class template, but they didn't conform to the current JSON scheme.

---

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

3 Files Affected:

• (modified) clang-tools-extra/clang-doc/JSONGenerator.cpp (+1-1)
• (modified) clang-tools-extra/clang-doc/assets/class-template.mustache (+16-18)
• (modified) clang-tools-extra/test/clang-doc/json/class.cpp (+18)

diff --git a/clang-tools-extra/clang-doc/JSONGenerator.cpp b/clang-tools-extra/clang-doc/JSONGenerator.cpp
index fab54591b8faa..ad76c40d49db8 100644
--- a/clang-tools-extra/clang-doc/JSONGenerator.cpp
+++ b/clang-tools-extra/clang-doc/JSONGenerator.cpp
@@ -628,7 +628,7 @@ static void serializeInfo(const RecordInfo &I, json::Object &Obj,
     if (!PubFunctionsArrayRef.empty())
       insertArray(Obj, PubFunctionsArray, "PublicFunctions");
     if (!ProtFunctionsArrayRef.empty())
-      Obj["ProtectedFunctions"] = ProtFunctionsArray;
+      insertArray(Obj, ProtFunctionsArray, "ProtectedFunctions");
   }
 
   if (!I.Members.empty()) {
diff --git a/clang-tools-extra/clang-doc/assets/class-template.mustache b/clang-tools-extra/clang-doc/assets/class-template.mustache
index 19e6e6adf1b44..368fc0472b3ca 100644
--- a/clang-tools-extra/clang-doc/assets/class-template.mustache
+++ b/clang-tools-extra/clang-doc/assets/class-template.mustache
@@ -63,22 +63,22 @@
                         </details>
                     </li>
                     {{/HasPublicFunctions}}
-                    {{#ProtectedFunction}}
+                    {{#HasProtectedFunctions}}
                     <li>
                         <details open>
                             <summary class="sidebar-section">
-                                <a class="sidebar-item" href="#ProtectedFunction">Protected Method</a>
+                                <a class="sidebar-item" href="#ProtectedMethods">Protected Methods</a>
                             </summary>
                             <ul>
-                                {{#Obj}}
+                                {{#ProtectedFunctions}}
                                 <li class="sidebar-item-container">
-                                    <a class="sidebar-item" href="#{{ID}}">{{Name}}</a>
+                                    <a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
                                 </li>
-                                {{/Obj}}
+                                {{/ProtectedFunctions}}
                             </ul>
                         </details>
                     </li>
-                    {{/ProtectedFunction}}
+                    {{/HasProtectedFunctions}}
                     {{#HasEnums}}
                     <li>
                         <details open>
@@ -198,18 +198,16 @@
                     {{/PublicFunctions}}
                 </section>
                 {{/PublicFunctions}}
-                {{#ProtectedFunction}}
-                <li class="sidebar-section">
-                    <a class="sidebar-item" href="#ProtectedFunction">Protected Method</a>
-                </li>
-                <ul>
-                    {{#Obj}}
-                    <li class="sidebar-item-container">
-                        <a class="sidebar-item" href="#{{ID}}">{{Name}}</a>
-                    </li>
-                    {{/Obj}}
-                </ul>
-                {{/ProtectedFunction}}
+                {{#HasProtectedFunctions}}
+                <section id="ProtectedMethods" class="section-container">
+                    <h2>Protected Methods</h2>
+                    <div>
+                        {{#PublicFunctions}}
+                        {{>FunctionPartial}}
+                        {{/PublicFunctions}}
+                    </div>
+                </section>
+                {{/HasProtectedFunctions}}
                 {{#HasEnums}}
                 <section id="Enums" class="section-container">
                     <h2>Enumerations</h2>
diff --git a/clang-tools-extra/test/clang-doc/json/class.cpp b/clang-tools-extra/test/clang-doc/json/class.cpp
index 6356aee14c16c..869c6635418ae 100644
--- a/clang-tools-extra/test/clang-doc/json/class.cpp
+++ b/clang-tools-extra/test/clang-doc/json/class.cpp
@@ -170,6 +170,7 @@ struct MyClass {
 // CHECK-NEXT:    "HasEnums": true,
 // CHECK-NEXT:    "HasFriends": true,
 // CHECK-NEXT:    "HasPrivateMembers": true,
+// CHECK-NEXT:    "HasProtectedFunctions": true,
 // CHECK-NEXT:    "HasProtectedMembers": true,
 // CHECK-NEXT:    "HasPublicFunctions": true,
 // CHECK-NEXT:    "HasPublicMembers": true,
@@ -329,6 +330,23 @@ struct MyClass {
 // HTML-NEXT:         </div>
 // HTML-NEXT:     </div>
 // HTML-NEXT: </section>
+// HTML:      <section id="ProtectedMethods" class="section-container">
+// HTML-NEXT:     <h2>Protected Methods</h2>
+// HTML-NEXT:     <div>
+// HTML-NEXT:         <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
+// HTML-NEXT:                 <pre><code class="language-cpp code-clang-doc">int myMethod (int MyParam)</code></pre>
+// HTML-NEXT:                 <p>Defined at line  of file </p>
+// HTML-NEXT:         </div>
+// HTML-NEXT:         <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
+// HTML-NEXT:                 <pre><code class="language-cpp code-clang-doc">void staticMethod ()</code></pre>
+// HTML-NEXT:                 <p>Defined at line  of file </p>
+// HTML-NEXT:         </div>
+// HTML-NEXT:         <div id="{{([0-9A-F]{40})}}" class="delimiter-container">
+// HTML-NEXT:                 <pre><code class="language-cpp code-clang-doc">const int &amp; getConst ()</code></pre>
+// HTML-NEXT:                 <p>Defined at line  of file </p>
+// HTML-NEXT:         </div>
+// HTML-NEXT:     </div>
+// HTML-NEXT: </section>
 // HTML:      <section id="Classes" class="section-container">
 // HTML-NEXT:     <h2>Inner Classes</h2>
 // HTML-NEXT:     <ul class="class-container">

[evelez7]

HTML preview: https://erickvelez.com/clang-doc-mustache-output/pr174884/GlobalNamespace/_ZTV7MyClass.html

[ilovepi]

Suggested change

	insertArray(Obj, ProtFunctionsArray, "ProtectedFunctions");
	insertArray(Obj, ProtFunctionsArray, "ProtectedMethods");

If we're touching this, maybe we should name these and the tags in the templates consistently? WDYT? I'm fine either way, and this is more a minor nit than something that should block landing. We can follow up later w/ a small cleanup.

[evelez7]

Yeah these names need to be cleaned up across the templates as well, but I've put it off to not make these patches unnecessarily large and to get the functionality out there first. I'm planning to followup on these soon.

[ilovepi]

sounds good. When one of us gets a chance lets clean those up. Or file a bug and tag it good first issue? its a trivial thing to do for a new person, so maybe that's better?

[evelez7]

I already have a chore patch ready with it unfortunately. I can separate it out since it has a few more things that needed to be addressed like typos.

[evelez7]

Merge activity

• Jan 9, 1:00 AM UTC: A user started a stack merge that includes this pull request via Graphite.
• Jan 9, 1:01 AM UTC: @evelez7 merged this pull request with Graphite.