Skip to content

Commit 9ca2a7b

Browse files
evelez7evelez7
committed
[clang-doc] add param comments to comment template
1 parent 625b470 commit 9ca2a7b

File tree

3 files changed

+102
-92
lines changed

3 files changed

+102
-92
lines changed

‎clang-tools-extra/clang-doc/JSONGenerator.cpp‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,8 +147,10 @@ static Object serializeComment(const CommentInfo &I, Object &Description) {
147147
Child.insert({"ParamName", I.ParamName});
148148
Child.insert({"Direction", I.Direction});
149149
Child.insert({"Explicit", I.Explicit});
150-
Child.insert({"Children", ChildArr});
151-
Obj.insert({commentKindToString(I.Kind), ChildVal});
150+
auto TextCommentsArray = extractTextComments(CARef.front().getAsObject());
151+
Child.insert({"Children", TextCommentsArray});
152+
if (I.Kind == CommentKind::CK_ParamCommandComment)
153+
insertComment(Description, ChildVal, "ParamComments");
152154
return Obj;
153155
}
154156

‎clang-tools-extra/clang-doc/assets/comment-template.mustache‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,14 @@
2424
{{>Comments}}
2525
{{/Children}}
2626
{{/ParagraphComment}}
27+
{{#HasParamComments}}
28+
<h3>Parameters</h3>
29+
{{#ParamComments}}
30+
<div>
31+
<b>{{ParamName}}</b> {{#Explicit}}{{Direction}}{{/Explicit}} {{#Children}}{{>Comments}}{{/Children}}
32+
</div>
33+
{{/ParamComments}}
34+
{{/HasParamComments}}
2735
{{#BlockCommandComment}}
2836
<div class="block-command-comment__command">
2937
<div class="block-command-command">

‎clang-tools-extra/test/clang-doc/basic-project.mustache.test‎

Lines changed: 90 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -259,24 +259,24 @@ HTML-CALC: <p></p>
259259
HTML-CALC: </div>
260260
HTML-CALC: <div>
261261
HTML-CALC: <p></p>
262-
HTML-CALC-NOT: </div>
263-
HTML-CALC-NOT: <h3>Parameters</h3>
264-
HTML-CALC-NOT: <div>
265-
HTML-CALC-NOT: <b>a</b> <div>
266-
HTML-CALC-NOT: <p> First integer.</p>
267-
HTML-CALC-NOT: </div>
268-
HTML-CALC-NOT: <div>
269-
HTML-CALC-NOT: <p></p>
270-
HTML-CALC-NOT: </div>
271-
HTML-CALC-NOT: </div>
272-
HTML-CALC-NOT: <div>
273-
HTML-CALC-NOT: <b>b</b> <div>
274-
HTML-CALC-NOT: <p> Second integer.</p>
275-
HTML-CALC-NOT: </div>
276-
HTML-CALC-NOT: <div>
277-
HTML-CALC-NOT: <p></p>
278-
HTML-CALC-NOT: </div>
279-
HTML-CALC-NOT: </div>
262+
HTML-CALC: </div>
263+
HTML-CALC: <h3>Parameters</h3>
264+
HTML-CALC: <div>
265+
HTML-CALC: <b>a</b> <div>
266+
HTML-CALC: <p> First integer.</p>
267+
HTML-CALC: </div>
268+
HTML-CALC: <div>
269+
HTML-CALC: <p></p>
270+
HTML-CALC: </div>
271+
HTML-CALC: </div>
272+
HTML-CALC: <div>
273+
HTML-CALC: <b>b</b> <div>
274+
HTML-CALC: <p> Second integer.</p>
275+
HTML-CALC: </div>
276+
HTML-CALC: <div>
277+
HTML-CALC: <p></p>
278+
HTML-CALC: </div>
279+
HTML-CALC: </div>
280280
HTML-CALC: </div>
281281
HTML-CALC: </div>
282282
HTML-CALC: </div>
@@ -316,24 +316,24 @@ HTML-CALC: <p></p>
316316
HTML-CALC: </div>
317317
HTML-CALC: <div>
318318
HTML-CALC: <p></p>
319-
HTML-CALC-NOT: </div>
320-
HTML-CALC-NOT: <h3>Parameters</h3>
321-
HTML-CALC-NOT: <div>
322-
HTML-CALC-NOT: <b>a</b> <div>
323-
HTML-CALC-NOT: <p> First integer.</p>
324-
HTML-CALC-NOT: </div>
325-
HTML-CALC-NOT: <div>
326-
HTML-CALC-NOT: <p></p>
327-
HTML-CALC-NOT: </div>
328-
HTML-CALC-NOT: </div>
329-
HTML-CALC-NOT: <div>
330-
HTML-CALC-NOT: <b>b</b> <div>
331-
HTML-CALC-NOT: <p> Second integer.</p>
332-
HTML-CALC-NOT: </div>
333-
HTML-CALC-NOT: <div>
334-
HTML-CALC-NOT: <p></p>
335-
HTML-CALC-NOT: </div>
336-
HTML-CALC-NOT: </div>
319+
HTML-CALC: </div>
320+
HTML-CALC: <h3>Parameters</h3>
321+
HTML-CALC: <div>
322+
HTML-CALC: <b>a</b> <div>
323+
HTML-CALC: <p> First integer.</p>
324+
HTML-CALC: </div>
325+
HTML-CALC: <div>
326+
HTML-CALC: <p></p>
327+
HTML-CALC: </div>
328+
HTML-CALC: </div>
329+
HTML-CALC: <div>
330+
HTML-CALC: <b>b</b> <div>
331+
HTML-CALC: <p> Second integer.</p>
332+
HTML-CALC: </div>
333+
HTML-CALC: <div>
334+
HTML-CALC: <p></p>
335+
HTML-CALC: </div>
336+
HTML-CALC: </div>
337337
HTML-CALC: </div>
338338
HTML-CALC: </div>
339339
HTML-CALC: </div>
@@ -353,23 +353,23 @@ HTML-CALC: <p></p>
353353
HTML-CALC: </div>
354354
HTML-CALC: <div>
355355
HTML-CALC: <p></p>
356-
HTML-CALC-NOT: </div>
357-
HTML-CALC-NOT: <h3>Parameters</h3>
358-
HTML-CALC-NOT: <div>
359-
HTML-CALC-NOT: <b>a</b> <div>
360-
HTML-CALC-NOT: <p> First integer.</p>
361-
HTML-CALC-NOT: </div>
362-
HTML-CALC-NOT: <div>
363-
HTML-CALC-NOT: <p></p>
364-
HTML-CALC-NOT: </div>
365-
HTML-CALC-NOT: </div>
366-
HTML-CALC-NOT: <div>
367-
HTML-CALC-NOT: <b>b</b> <div>
368-
HTML-CALC-NOT: <p> Second integer.</p>
369-
HTML-CALC-NOT: </div>
370-
HTML-CALC-NOT: <div>
371-
HTML-CALC-NOT: <p></p>
372-
HTML-CALC-NOT: </div>
356+
HTML-CALC: </div>
357+
HTML-CALC: <h3>Parameters</h3>
358+
HTML-CALC: <div>
359+
HTML-CALC: <b>a</b> <div>
360+
HTML-CALC: <p> First integer.</p>
361+
HTML-CALC: </div>
362+
HTML-CALC: <div>
363+
HTML-CALC: <p></p>
364+
HTML-CALC: </div>
365+
HTML-CALC: </div>
366+
HTML-CALC: <div>
367+
HTML-CALC: <b>b</b> <div>
368+
HTML-CALC: <p> Second integer.</p>
369+
HTML-CALC: </div>
370+
HTML-CALC: <div>
371+
HTML-CALC: <p></p>
372+
HTML-CALC: </div>
373373
HTML-CALC: </div>
374374
HTML-CALC: </div>
375375
HTML-CALC: </div>
@@ -390,23 +390,23 @@ HTML-CALC: <p></p>
390390
HTML-CALC: </div>
391391
HTML-CALC: <div>
392392
HTML-CALC: <p></p>
393-
HTML-CALC-NOT: </div>
394-
HTML-CALC-NOT: <h3>Parameters</h3>
395-
HTML-CALC-NOT: <div>
396-
HTML-CALC-NOT: <b>a</b> <div>
397-
HTML-CALC-NOT: <p> First integer.</p>
398-
HTML-CALC-NOT: </div>
399-
HTML-CALC-NOT: <div>
400-
HTML-CALC-NOT: <p></p>
401-
HTML-CALC-NOT: </div>
402-
HTML-CALC-NOT: </div>
403-
HTML-CALC-NOT: <div>
404-
HTML-CALC-NOT: <b>b</b> <div>
405-
HTML-CALC-NOT: <p> Second integer.</p>
406-
HTML-CALC-NOT: </div>
407-
HTML-CALC-NOT: <div>
408-
HTML-CALC-NOT: <p></p>
409-
HTML-CALC-NOT: </div>
393+
HTML-CALC: </div>
394+
HTML-CALC: <h3>Parameters</h3>
395+
HTML-CALC: <div>
396+
HTML-CALC: <b>a</b> <div>
397+
HTML-CALC: <p> First integer.</p>
398+
HTML-CALC: </div>
399+
HTML-CALC: <div>
400+
HTML-CALC: <p></p>
401+
HTML-CALC: </div>
402+
HTML-CALC: </div>
403+
HTML-CALC: <div>
404+
HTML-CALC: <b>b</b> <div>
405+
HTML-CALC: <p> Second integer.</p>
406+
HTML-CALC: </div>
407+
HTML-CALC: <div>
408+
HTML-CALC: <p></p>
409+
HTML-CALC: </div>
410410
HTML-CALC: </div>
411411
HTML-CALC: </div>
412412
HTML-CALC: </div>
@@ -506,20 +506,20 @@ HTML-RECTANGLE: <p></p>
506506
HTML-RECTANGLE: </div>
507507
HTML-RECTANGLE: <div>
508508
HTML-RECTANGLE: <p></p>
509-
HTML-RECTANGLE-NOT: </div>
510-
HTML-RECTANGLE-NOT: <h3>Parameters</h3>
511-
HTML-RECTANGLE-NOT: <div>
512-
HTML-RECTANGLE-NOT: <b>width</b> <div>
513-
HTML-RECTANGLE-NOT: <p> Width of the rectangle.</p>
514-
HTML-RECTANGLE-NOT: </div>
515-
HTML-RECTANGLE-NOT: <div>
516-
HTML-RECTANGLE-NOT: <p></p>
517-
HTML-RECTANGLE-NOT: </div>
518-
HTML-RECTANGLE-NOT: </div>
519-
HTML-RECTANGLE-NOT: <div>
520-
HTML-RECTANGLE-NOT: <b>height</b> <div>
521-
HTML-RECTANGLE-NOT: <p> Height of the rectangle.</p>
522-
HTML-RECTANGLE-NOT: </div>
509+
HTML-RECTANGLE: </div>
510+
HTML-RECTANGLE: <h3>Parameters</h3>
511+
HTML-RECTANGLE: <div>
512+
HTML-RECTANGLE: <b>width</b> <div>
513+
HTML-RECTANGLE: <p> Width of the rectangle.</p>
514+
HTML-RECTANGLE: </div>
515+
HTML-RECTANGLE: <div>
516+
HTML-RECTANGLE: <p></p>
517+
HTML-RECTANGLE: </div>
518+
HTML-RECTANGLE: </div>
519+
HTML-RECTANGLE: <div>
520+
HTML-RECTANGLE: <b>height</b> <div>
521+
HTML-RECTANGLE: <p> Height of the rectangle.</p>
522+
HTML-RECTANGLE: </div>
523523
HTML-RECTANGLE: </div>
524524
HTML-RECTANGLE: </div>
525525
HTML-RECTANGLE: </div>
@@ -659,12 +659,12 @@ HTML-CIRCLE: <p></p>
659659
HTML-CIRCLE: </div>
660660
HTML-CIRCLE: <div>
661661
HTML-CIRCLE: <p></p>
662-
HTML-CIRCLE-NOT: </div>
663-
HTML-CIRCLE-NOT: <h3>Parameters</h3>
664-
HTML-CIRCLE-NOT: <div>
665-
HTML-CIRCLE-NOT: <b>radius</b> <div>
666-
HTML-CIRCLE-NOT: <p> Radius of the circle.</p>
667-
HTML-CIRCLE-NOT: </div>
662+
HTML-CIRCLE: </div>
663+
HTML-CIRCLE: <h3>Parameters</h3>
664+
HTML-CIRCLE: <div>
665+
HTML-CIRCLE: <b>radius</b> <div>
666+
HTML-CIRCLE: <p> Radius of the circle.</p>
667+
HTML-CIRCLE: </div>
668668
HTML-CIRCLE: </div>
669669
HTML-CIRCLE: </div>
670670
HTML-CIRCLE: </div>

0 commit comments

Comments
 (0)