aboutsummaryrefslogtreecommitdiff
path: root/clang-tools-extra/clang-doc/assets/comment-template.mustache
blob: 4e38e5fb92d184bbc4a519adf3017303881d67c8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
{{!
    Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
    See https://llvm.org/LICENSE.txt for license information.
    SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
    
    This file defines templates for generating comments
}}
{{#BriefComments}}
    <div>
    {{#.}}
        <p>{{TextComment}}</p>
    {{/.}}
    </div>
{{/BriefComments}}
{{#ParagraphComments}}
    <div>
    {{#.}}
        <p>{{TextComment}}</p>
    {{/.}}
    </div>
{{/ParagraphComments}}
{{#ParagraphComment}}
    {{#Children}}
    {{>Comments}}
    {{/Children}}
{{/ParagraphComment}}
{{#HasParamComments}}
    <h3>Parameters</h3>
    {{#ParamComments}}
    <div>
        <b>{{ParamName}}</b> {{#Explicit}}{{Direction}}{{/Explicit}} {{#Children}}{{>Comments}}{{/Children}}
    </div> 
    {{/ParamComments}}
{{/HasParamComments}}
{{#HasReturnComments}}
    <h3>Returns</h3>
    {{#ReturnComments}}
        {{#.}}
        <p>{{TextComment}}</p>
        {{/.}}
    {{/ReturnComments}}
{{/HasReturnComments}}
{{#HasCodeComments}}
    <h3>Code</h3> 
    {{#CodeComments}}
    <div>
        <pre class="code-block">
            <code>
            {{#.}}
            {{.}}
            {{/.}}
            </code>
        </pre>
    </div>
    {{/CodeComments}}
{{/HasCodeComments}}
{{#BlockCommandComment}}
    <div class="block-command-comment__command">
        <div class="block-command-command">
            {{Command}}
        </div>
        <div>
            {{#Children}}
                {{>Comments}}
            {{/Children}}
        </div>
    </div>
{{/BlockCommandComment}}
{{#TextComment}}
    <div>
        <p>{{TextComment}}</p>
    </div>
{{/TextComment}}