summaryrefslogtreecommitdiffstats
path: root/templates/html/htmlmemdef.tpl
blob: e847732917892d6c3079b469f6c930bb1f5fd3f3 (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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
{# inputs: memberListInfo #}
{% if memberListInfo %}
  {% if memberListInfo.members %}
    <h2 class="groupheader">{{ memberListInfo.title }}</h2>
    {% for member in memberListInfo.members %}
      {% if member.detailsVisibleFor:compound.compoundKind %}
        <a class="anchor" id="{{ member.anchor }}"></a>
        <div class="memitem">
        <div class="memproto">
        {# write template declarations #}
        {% if member.language=='cpp' and member.templateDecls %}
          {% for targList in member.templateDecls %}
            {% spaceless %}
              <div class="memtemplate">
              template&lt;
              {% for targ in targList %}
                {{ targ.type }}{% if targ.name %} {{ targ.name }}{% endif %}{% if targ.defVal %}&#160;= {{ targ.defVal }}{% endif %}{% if not forloop.last %}, {% endif %}
              {% endfor %}
              &gt;
              </div>
            {% endspaceless %}
          {% endfor %}
        {% endif %}
        {# start of labels if present #}
        {% if member.labels %}
          <table class="mlabels"><tr><td class="mlabels-left">
        {% endif %}
        <table class="memname">
          <tr><td class="memname">
            {{ member.definition }}
            {# write argument list #}
            {% if member.hasParameters %}
              {% if member.isObjCMethod %}
                {% if member.parameters %}
                </td><td></td>
                {% endif %}
                {% for arg in member.parameters %}
                  {% if not forloop.first %}
                    <tr><td class="paramkey">{{ arg.namePart }}</td><td></td>
                  {% endif %}
                  <td class="paramtype">({{ arg.type }})&#160;</td><td class="paramname">
                  {% if arg.name or arg.type=='...' %}
                    <em>{% if not arg.name %}{{ arg.type }}{% else %}{{ arg.name }}{% endif %}</em>
                  {% endif %}
		  {% if not forloop.last %}
                    </td></tr>
                  {% endif %}
                {% endfor %}
              {% else %}
                </td><td>(</td>
                {% for arg in member.parameters %}
                  {% if member.isDefine %}
                    {% if not forloop.first %}
                      <tr><td class="paramkey"></td><td></td>
                    {% endif %}
                    <td class="paramtype"></td><td class="paramname">
		    {% spaceless %}
                      {% if arg.type %}
                        <em>{{ arg.type }}</em>
                      {% endif %}
                      {% if not forloop.last %}
                        ,</td></tr>
                      {% endif %}
		    {% endspaceless %}
                  {% else %} {# normal function/method #}
                    {% if forloop.first %}
                      <td class="paramtype">
                    {% endif %}
                    {% if arg.attrib %}{{ arg.attrib }} {% endif %}
                    {% if arg.type!='...' %}
                       {{ arg.type }}
                    {% endif %}
                    &#160;</td><td class="paramname">
                    {% if arg.name or arg.type=='...' %}
                      <em>{% if not arg.name %}{{ arg.type }}{% else %}{{ arg.name }}{% endif %}</em>
                    {% endif %}
                    {{ arg.array }}
                    {% if arg.defVal %} = {{ arg.defVal }}{% endif %}
		    {% if not forloop.last %}
                      ,</td></tr><tr><td class="paramkey"></td><td></td><td class="paramtype">
                    {% endif %}
                  {% endif %}
                {% endfor %}
		{% if member.parameters|length==0 %}
                  <td class="paramname">
                {% endif %}
                {% if member.parameters|length<2 %}
                  </td><td>)</td><td>
                {% else %}
                  &#160;</td></tr>
                  <tr><td></td><td>)</td><td></td><td>
                {% endif %}
                {{ member.extraTypeChars }}
                {% if member.hasConstQualifier %} const {% endif %}
                {% if member.hasVolatileQualifier %} volatile {% endif %}
                {% if member.hasRefQualifierLValue %} &amp; {% endif %}
                {% if member.hasRefQualifierRValue %} &amp;&amp; {% endif %}
                {{ member.trailingReturnType }}
              {% endif %}
            {% endif %}
            {# one line initializer #}
            {% if member.hasOneLineInitializer %}
              {% if member.isDefine %}&#160;&#160;&#160;{% endif %}
              {{ member.initializer }}
            {% endif %}
            {# exception list #}
            {% if member.exception %}
              {# TODO: special exception rendering for UNO IDL... #}
              {{ member.exception }}
            {% endif %}
          </td></tr>
        </table>
        {# end of labels if present #}
        {% if member.labels %}
          </td><td class="mlabels-right">{% spaceless %}
          {% for label in member.labels %}
            <span class="mlabel">{{ label }}</span>
          {% endfor %}{% endspaceless %}
          </td></tr></table>
        {% endif %}
        </div>
        <div class="memdoc">
        {# write group include #}
          {% if compound.compoundKind=="module" and config.SHOW_GROUPED_MEMB_INC and member.file %}
            <p><tt>{% spaceless %}
            {% if compound.language=='java' or compound.language=='idl' %}
            import&#160; "
            {% else %}
            #include&#160;&lt;
            {% endif %}
            {% with obj=member.file text=member.file.bareName %}
              {% include 'htmlobjlink.tpl' %}
            {% endwith %}
            {% if compound.language=='java' or compound.language=='idl' %}"
            {% else %}&gt;
            {% endif %}
            {% endspaceless %}</tt></p>
          {% endif %}
        {# multi-line initializer #}
          {% if member.hasMultiLineInitializer %}
            <b>{% if member.isDefine %}{{ tr.defineValue }}{% else %}{{ tr.initialValue }}{% endif %}</b>
            <div class="fragment">{{ member.initializerAsCode }}</div>
          {% endif %}
        {# brief description #}
          {% if member.brief and config.REPEAT_BRIEF and config.BRIEF_MEMBER_DESC %}
            <p>{{ member.brief }}</p>
          {% endif %}
        {# detailed description #}
          {# TODO: VHDL #}
          {{ member.details }}
        {# inbody description #}
          {{ member.inbodyDocs }}
        {# argument list #}
          {{ member.paramDocs }}
        {# enum values #}
          {% if member.isEnumeration and member.enumValues|length>0 %}
            <table class="fieldtable">
            <tr><th colspan="2">{{ tr.enumValues }}</th></tr>
            {% for enumVal in member.enumValues %}
              <tr><td class="fieldname"><em><a class="anchor" id="{{ enumVal.anchor}}"></a>{{ enumVal.name }}</em>&#160;</td>
                  <td class="fielddoc">{{ enumVal.brief }}{{ enumVal.details }}</td>
              </tr>
            {% endfor %}
            </table>
          {% endif %}
        {# reimplements #}
          {% if member.reimplements %}
            <p>
            {% markers mem in member.reimplements with tr.reimplements %}
              {% with obj=mem text=mem.class.name %}
                {% include 'htmlobjlink.tpl' %}
              {% endwith %}
            {% endmarkers %}
            </p>
          {% endif %}
          {% if member.implements %}
            <p>
            {% markers mem in member.implements with tr.implements %}
              {% with obj=mem text=mem.class.name %}
                {% include 'htmlobjlink.tpl' %}
              {% endwith %}
            {% endmarkers %}
            </p>
          {% endif %}
        {# reimplementedBy #}
          {% if member.reimplementedBy %}
            <p>
            {% markers mem in member.reimplementedBy with tr.reimplementedBy:member.reimplementedBy|length %}
              {% with obj=mem text=mem.class.name %}
                {% include 'htmlobjlink.tpl' %}
              {% endwith %}
            {% endmarkers %}
            </p>
          {% endif %}
          {% if member.implementedBy %}
            <p>
            {% markers mem in member.implementedBy with tr.implementedBy:member.implementedBy|length %}
              {% with obj=mem text=mem.class.name %}
                {% include 'htmlobjlink.tpl' %}
              {% endwith %}
            {% endmarkers %}
            </p>
          {% endif %}
        {# category relation #}
          {% if member.class and member.categoryRelation %}
            {% if member.category %}
              <p>
              {% markers mem in member.categoryRelation|list with tr.providedByCategory %}
                {% with obj=mem text=member.category.name %}
                  {% include 'htmlobjlink.tpl' %}
                {% endwith %}
              {% endmarkers %}
              </p>
            {% elif member.class.categoryOf %}
              <p>
              {% markers mem in member.categoryRelation|list with tr.extendsClass %}
                {% with obj=mem text=member.class.categoryOf.name %}
                  {% include 'htmlobjlink.tpl' %}
                {% endwith %}
              {% endmarkers %}
              </p>
            {% endif %}
          {% endif %}
        {# examples #}
          {% if member.examples %}
            <dl><dt><b>{{ tr.examples }}</b><dd>
            {% markers obj in member.examples with tr.exampleList:member.examples|length %}
              {% with text=obj.text %}
                {% include 'htmlobjlink.tpl' %}
              {% endwith %}
            {% endmarkers %}
            </dd></dl>
          {% endif %}
        {# type constraints #}
          {% with obj=member %}
            {% include 'htmltypeconstraints.tpl' %}
          {% endwith %}
        {# source def #}
          {% if member.sourceDef %}
            {% markers obj in member.sourceDef with tr.definedAtLineInSourceFile %}
              {% with text=obj.text %}
                {% include 'htmlobjlink.tpl' %}
              {% endwith %}
            {% endmarkers %}
          {% endif %}
        {# source refs #}
          {% if member.sourceRefs|length>0 %}
            <p>
            {% markers mem in member.sourceRefs with tr.sourceRefs:member.sourceRefs|length %}
              {% if mem.sourceDef and config.REFERENCES_LINK_SOURCE %}
                {% with obj=mem.sourceDef.0 text=mem.name|append:mem.functionQualifier %}
                  {% include 'htmlobjlink.tpl' %}
                {% endwith %}
              {% else %}
                {% with obj=mem text=mem.name|append:mem.functionQualifier %}
                  {% include 'htmlobjlink.tpl' %}
                {% endwith %}
              {% endif %}
            {% endmarkers %}
            </p>
          {% endif %}
        {# source refs by #}
          {% if member.sourceRefBys|length>0%}
            <p>
            {% markers mem in member.sourceRefBys with tr.sourceRefBys:member.sourceRefBys|length %}
              {% if mem.sourceDef and config.REFERENCES_LINK_SOURCE %}
                {% with obj=mem.sourceDef.0 text=mem.name|append:mem.functionQualifier %}
                  {% include 'htmlobjlink.tpl' %}
                {% endwith %}
              {% else %}
                {% with obj=mem text=mem.name|append:mem.functionQualifier %}
                  {% include 'htmlobjlink.tpl' %}
                {% endwith %}
              {% endif %}
            {% endmarkers %}
            </p>
          {% endif %}
        {# inline code #}
          {% if member.hasSources and config.INLINE_SOURCES %}
            <div class="fragment">
            {{ member.sourceCode }}
            </div>
          {% endif %}
        {# call graph #}
          {% if member.hasCallGraph %}
             {% with obj=member %}
               {% include 'htmldynheader.tpl' %}
             {% endwith %}
               {{ tr.callGraph }}
             </div>
             {% with obj=member %}
               {% include 'htmldyncontents.tpl' %}
             {% endwith %}
               {{ member.callGraph }}
             </div>
          {% endif %}
        {# caller graph #}
          {% if member.hasCallerGraph %}
             {% with obj=member %}
               {% include 'htmldynheader.tpl' %}
             {% endwith %}
               {{ tr.callerGraph }}
             </div>
             {% with obj=member %}
               {% include 'htmldyncontents.tpl' %}
             {% endwith %}
               {{ member.callerGraph }}
             </div>
          {% endif %}
        </div>
        </div>
      {% endif %}
    {% endfor %} {# for each member #}
  {% endif %}
{% endif %}