summaryrefslogtreecommitdiff
path: root/peripheral/libupm/doxy/node/generators/yuidoc/tmpl/partials/props.handlebars
blob: 696e7209dc05022cfe1ff9123435385d1977bc2a (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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
<div id="property_{{name}}" class="property item{{#if access}} {{access}}{{/if}}{{#if deprecated}} deprecated{{/if}}{{#if extended_from}} inherited{{/if}}">
    <h3 class="name"><code>{{name}}</code></h3>
    <span class="type">{{#crossLink type}}{{/crossLink}}</span>

    {{#if deprecated}}
        <span class="flag deprecated"{{#if deprecationMessage}} title="{{deprecationMessage}}"{{/if}}>deprecated</span>
    {{/if}}

    {{#if access}}
        <span class="flag {{access}}">{{access}}</span>
    {{/if}}

    {{#if final}}
        <span class="flag final">final</span>
    {{/if}}

    {{#if static}}
        <span class="flag static">static</span>
    {{/if}}

    <div class="meta">
        {{#if overwritten_from}}
            <p>Inherited from
            <a href="{{crossLinkRaw overwritten_from/class}}#property_{{overwritten_from/name}}">
                {{overwritten_from/class}}
            </a>
            {{#if foundAt}}
            but overwritten in
            {{/if}}
        {{else}}
            {{#if extended_from}}
                <p>Inherited from
                <a href="{{crossLinkRaw extended_from}}#property_{{name}}">{{extended_from}}</a>:
            {{else}}
                {{#providedBy}}
                    <p>Provided by the <a href="../modules/{{.}}.html">{{.}}</a> module.</p>
                {{/providedBy}}
                <p>
                {{#if foundAt}}
                Defined in
                {{/if}}
            {{/if}}
        {{/if}}
        {{#if foundAt}}
        <a href="{{foundAt}}">`{{{file}}}:{{{line}}}`</a>
        {{/if}}
        </p>

        {{#if deprecationMessage}}
            <p>Deprecated: {{deprecationMessage}}</p>
        {{/if}}

        {{#if since}}
            <p>Available since {{since}}</p>
        {{/if}}
    </div>

    <div class="description">
        {{{propertyDescription}}}
    </div>

    {{#if default}}
        <p><strong>Default:</strong> {{default}}</p>
    {{/if}}

    {{#example}}
        <div class="example">
            <h4>Example:</h4>

            <div class="example-content">
                {{{.}}}
            </div>
        </div>
    {{/example}}

    {{#if subprops}}
        <h4>Sub-properties:</h4>

        <ul class="params-list">
            {{#subprops}}
            <li class="param">
                {{#if optional}}
                    <code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code>
                    <span class="type">{{#crossLink type}}{{/crossLink}}</span>
                    <span class="flag optional" title="This property is optional.">optional</span>
                {{else}}
                    <code class="param-name">{{name}}</code>
                    <span class="type">{{#crossLink type}}{{/crossLink}}</span>
                {{/if}}

                <div class="param-description">
                    {{{description}}}
                </div>

                {{#if subprops}}
                    <ul class="params-list">
                        {{#subprops}}
                        <li class="param">
                            {{#if optional}}
                                <code class="param-name optional">[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]</code>
                                <span class="type">{{#crossLink type}}{{/crossLink}}</span>
                                <span class="flag optional" title="This property is optional.">optional</span>
                            {{else}}
                                <code class="param-name">{{name}}</code>
                                <span class="type">{{#crossLink type}}{{/crossLink}}</span>
                            {{/if}}

                            <div class="param-description">
                                {{{description}}}
                            </div>
                        </li>
                        {{/subprops}}
                    </ul>
                {{/if}}
            </li>
            {{/subprops}}
        </ul>
    {{/if}}
</div>