Skip to content

[clang-doc] add param comments to comment template #150470

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.

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

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 4 additions & 2 deletions clang-tools-extra/clang-doc/JSONGenerator.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,10 @@ static Object serializeComment(const CommentInfo &I, Object &Description) {
Child.insert({"ParamName", I.ParamName});
Child.insert({"Direction", I.Direction});
Child.insert({"Explicit", I.Explicit});
Child.insert({"Children", ChildArr});
Obj.insert({commentKindToString(I.Kind), ChildVal});
auto TextCommentsArray = extractTextComments(CARef.front().getAsObject());
Child.insert({"Children", TextCommentsArray});
if (I.Kind == CommentKind::CK_ParamCommandComment)
insertComment(Description, ChildVal, "ParamComments");
return Obj;
}

Expand Down
8 changes: 8 additions & 0 deletions clang-tools-extra/clang-doc/assets/comment-template.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@
{{>Comments}}
{{/Children}}
{{/ParagraphComment}}
{{#HasParamComments}}
<h3>Parameters</h3>
{{#ParamComments}}
<div>
<b>{{ParamName}}</b> {{#Explicit}}{{Direction}}{{/Explicit}} {{#Children}}{{>Comments}}{{/Children}}
</div>
{{/ParamComments}}
{{/HasParamComments}}
{{#BlockCommandComment}}
<div class="block-command-comment__command">
<div class="block-command-command">
Expand Down
180 changes: 90 additions & 90 deletions clang-tools-extra/test/clang-doc/basic-project.mustache.test
Original file line number Diff line number Diff line change
Expand Up @@ -259,24 +259,24 @@ HTML-CALC: <p></p>
HTML-CALC: </div>
HTML-CALC: <div>
HTML-CALC: <p></p>
HTML-CALC-NOT: </div>
HTML-CALC-NOT: <h3>Parameters</h3>
HTML-CALC-NOT: <div>
HTML-CALC-NOT: <b>a</b> <div>
HTML-CALC-NOT: <p> First integer.</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: <div>
HTML-CALC-NOT: <b>b</b> <div>
HTML-CALC-NOT: <p> Second integer.</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: <h3>Parameters</h3>
HTML-CALC: <div>
HTML-CALC: <b>a</b> <div>
HTML-CALC: <p> First integer.</p>
HTML-CALC: </div>
HTML-CALC: <div>
HTML-CALC: <p></p>
HTML-CALC: </div>
HTML-CALC: </div>
HTML-CALC: <div>
HTML-CALC: <b>b</b> <div>
HTML-CALC: <p> Second integer.</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>
Expand Down Expand Up @@ -316,24 +316,24 @@ HTML-CALC: <p></p>
HTML-CALC: </div>
HTML-CALC: <div>
HTML-CALC: <p></p>
HTML-CALC-NOT: </div>
HTML-CALC-NOT: <h3>Parameters</h3>
HTML-CALC-NOT: <div>
HTML-CALC-NOT: <b>a</b> <div>
HTML-CALC-NOT: <p> First integer.</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: <div>
HTML-CALC-NOT: <b>b</b> <div>
HTML-CALC-NOT: <p> Second integer.</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: <h3>Parameters</h3>
HTML-CALC: <div>
HTML-CALC: <b>a</b> <div>
HTML-CALC: <p> First integer.</p>
HTML-CALC: </div>
HTML-CALC: <div>
HTML-CALC: <p></p>
HTML-CALC: </div>
HTML-CALC: </div>
HTML-CALC: <div>
HTML-CALC: <b>b</b> <div>
HTML-CALC: <p> Second integer.</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>
Expand All @@ -353,23 +353,23 @@ HTML-CALC: <p></p>
HTML-CALC: </div>
HTML-CALC: <div>
HTML-CALC: <p></p>
HTML-CALC-NOT: </div>
HTML-CALC-NOT: <h3>Parameters</h3>
HTML-CALC-NOT: <div>
HTML-CALC-NOT: <b>a</b> <div>
HTML-CALC-NOT: <p> First integer.</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: <div>
HTML-CALC-NOT: <b>b</b> <div>
HTML-CALC-NOT: <p> Second integer.</p>
HTML-CALC-NOT: </div>
HTML-CALC-NOT: <div>
HTML-CALC-NOT: <p></p>
HTML-CALC-NOT: </div>
HTML-CALC: </div>
HTML-CALC: <h3>Parameters</h3>
HTML-CALC: <div>
HTML-CALC: <b>a</b> <div>
HTML-CALC: <p> First integer.</p>
HTML-CALC: </div>
HTML-CALC: <div>
HTML-CALC: <p></p>
HTML-CALC: </div>
HTML-CALC: </div>
HTML-CALC: <div>
HTML-CALC: <b>b</b> <div>
HTML-CALC: <p> Second integer.</p>
HTML-CALC: </div>
HTML-CALC: <div>
HTML-CALC: <p></p>
HTML-CALC: </div>
HTML-CALC: </div>
HTML-CALC: </div>
HTML-CALC: </div>
Expand All @@ -390,23 +390,23 @@ HTML-CALC: <p></p>
HTML-CALC: </div>
HTML-CALC: <div>
HTML-CALC: <p></p>
HTML-CALC-NOT: </div>
HTML-CALC-NOT: <h3>Parameters</h3>
HTML-CALC-NOT: <div>
HTML-CALC-NOT: <b>a</b> <div>
HTML-CALC-NOT: <p> First integer.</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: <div>
HTML-CALC-NOT: <b>b</b> <div>
HTML-CALC-NOT: <p> Second integer.</p>
HTML-CALC-NOT: </div>
HTML-CALC-NOT: <div>
HTML-CALC-NOT: <p></p>
HTML-CALC-NOT: </div>
HTML-CALC: </div>
HTML-CALC: <h3>Parameters</h3>
HTML-CALC: <div>
HTML-CALC: <b>a</b> <div>
HTML-CALC: <p> First integer.</p>
HTML-CALC: </div>
HTML-CALC: <div>
HTML-CALC: <p></p>
HTML-CALC: </div>
HTML-CALC: </div>
HTML-CALC: <div>
HTML-CALC: <b>b</b> <div>
HTML-CALC: <p> Second integer.</p>
HTML-CALC: </div>
HTML-CALC: <div>
HTML-CALC: <p></p>
HTML-CALC: </div>
HTML-CALC: </div>
HTML-CALC: </div>
HTML-CALC: </div>
Expand Down Expand Up @@ -506,20 +506,20 @@ HTML-RECTANGLE: <p></p>
HTML-RECTANGLE: </div>
HTML-RECTANGLE: <div>
HTML-RECTANGLE: <p></p>
HTML-RECTANGLE-NOT: </div>
HTML-RECTANGLE-NOT: <h3>Parameters</h3>
HTML-RECTANGLE-NOT: <div>
HTML-RECTANGLE-NOT: <b>width</b> <div>
HTML-RECTANGLE-NOT: <p> Width 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: <div>
HTML-RECTANGLE-NOT: <b>height</b> <div>
HTML-RECTANGLE-NOT: <p> Height of the rectangle.</p>
HTML-RECTANGLE-NOT: </div>
HTML-RECTANGLE: </div>
HTML-RECTANGLE: <h3>Parameters</h3>
HTML-RECTANGLE: <div>
HTML-RECTANGLE: <b>width</b> <div>
HTML-RECTANGLE: <p> Width of the rectangle.</p>
HTML-RECTANGLE: </div>
HTML-RECTANGLE: <div>
HTML-RECTANGLE: <p></p>
HTML-RECTANGLE: </div>
HTML-RECTANGLE: </div>
HTML-RECTANGLE: <div>
HTML-RECTANGLE: <b>height</b> <div>
HTML-RECTANGLE: <p> Height of the rectangle.</p>
HTML-RECTANGLE: </div>
HTML-RECTANGLE: </div>
HTML-RECTANGLE: </div>
HTML-RECTANGLE: </div>
Expand Down Expand Up @@ -659,12 +659,12 @@ HTML-CIRCLE: <p></p>
HTML-CIRCLE: </div>
HTML-CIRCLE: <div>
HTML-CIRCLE: <p></p>
HTML-CIRCLE-NOT: </div>
HTML-CIRCLE-NOT: <h3>Parameters</h3>
HTML-CIRCLE-NOT: <div>
HTML-CIRCLE-NOT: <b>radius</b> <div>
HTML-CIRCLE-NOT: <p> Radius of the circle.</p>
HTML-CIRCLE-NOT: </div>
HTML-CIRCLE: </div>
HTML-CIRCLE: <h3>Parameters</h3>
HTML-CIRCLE: <div>
HTML-CIRCLE: <b>radius</b> <div>
HTML-CIRCLE: <p> Radius of the circle.</p>
HTML-CIRCLE: </div>
HTML-CIRCLE: </div>
HTML-CIRCLE: </div>
HTML-CIRCLE: </div>
Expand Down
Loading