annotate doc/templates/nonclass_members_tables.tmpl @ 249:f4dc208aa1e3

doc: improve readability
author David Demelier <markand@malikania.fr>
date Tue, 01 Dec 2020 17:18:12 +0100
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
249
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 {% if exists("groups") %}## Modules
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
2
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 | Name |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 | -------------- |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 {% for child in groups %}| **[{{child.title}}]({{child.url}})** {% if existsIn(child, "brief") %}<br>{{child.brief}}{% endif %} |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 {% endfor %}{% endif %}
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 {% if exists("dirs") %}## Directories
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
8
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 | Name |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 | -------------- |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 {% for child in dirs %}| **[{{child.title}}]({{child.url}})** {% if existsIn(child, "brief") %}<br>{{child.brief}}{% endif %} |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 {% endfor %}{% endif %}
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 {% if exists("files") %}## Files
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
14
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 | Name |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 | -------------- |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 {% for child in files %}| **[{{child.title}}]({{child.url}})** {% if existsIn(child, "brief") %}<br>{{child.brief}}{% endif %} |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 {% endfor %}{% endif %}
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 {% if exists("namespaces") %}## Namespaces
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
20
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 | Name |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 | -------------- |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 {% for child in namespaces %}| **[{{child.name}}]({{child.url}})** {% if existsIn(child, "brief") %}<br>{{child.brief}}{% endif %} |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 {% endfor %}{% endif %}
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 {% if exists("publicClasses") %}## Classes
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
26
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 | | Name |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 | -------------- | -------------- |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 {% for child in publicClasses %}| {{child.kind}} | **[{{child.name}}]({{child.url}})** {% if existsIn(child, "brief") %}<br>{{child.brief}}{% endif %} |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 {% endfor %}{% endif %}
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 {% if exists("publicTypes") %}## Types
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
32
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 | | Name |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 | -------------- | -------------- |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 {% for child in publicTypes %}| {% if existsIn(child, "templateParams") %}template \<{% for param in child.templateParams %}{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif %}{% if not loop.is_last %},{% endif %}{% endfor %}\></br>{% endif %}{{child.kind}}{% if existsIn(child, "type") %} {{child.type}}{% endif %} | **[{{child.name}}]({{child.url}})** {% if child.kind == "enum" %}{ {% for enumvalue in child.enumvalues %}{{enumvalue.name}}{% if existsIn(enumvalue, "initializer") %} {{enumvalue.initializer}}{% endif %}{% if not loop.is_last %}, {% endif %}{% endfor %} }{% endif %}{% if existsIn(child, "brief") %}<br>{{child.brief}}{% endif %} |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 {% endfor %}{% endif %}
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 {% if exists("publicSlots") %}## Slots
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
38
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 | | Name |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 | -------------- | -------------- |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 {% for child in publicSlots %}| {% if existsIn(child, "templateParams") %}template \<{% for param in child.templateParams %}{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif %}{% if not loop.is_last %},{% endif %}{% endfor %}\></br>{% endif %}{% if child.virtual %}virtual {% endif %}{% if existsIn(child, "type") %}{{child.type}}{% endif %} | **[{{child.name}}]({{child.url}})**({% for param in child.params %}{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif %}{% if not loop.is_last %}, {% endif %}{% endfor %}){% if child.const %} const{% endif %}{% if child.override %} override{% endif %}{% if child.default %} =default{% endif %}{% if child.deleted %} =deleted{% endif %}{% if child.pureVirtual %} =0{% endif %} {% if existsIn(child, "brief") %}<br>{{child.brief}}{% endif %} |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 {% endfor %}{% endif %}
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 {% if exists("publicSignals") %}## Signals
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
44
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 | | Name |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 | -------------- | -------------- |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 {% for child in publicSignals %}| {% if existsIn(child, "templateParams") %}template \<{% for param in child.templateParams %}{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif %}{% if not loop.is_last %},{% endif %}{% endfor %}\></br>{% endif %}{% if child.virtual %}virtual {% endif %}{% if existsIn(child, "type") %}{{child.type}}{% endif %} | **[{{child.name}}]({{child.url}})**({% for param in child.params %}{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif %}{% if not loop.is_last %}, {% endif %}{% endfor %}){% if child.const %} const{% endif %}{% if child.override %} override{% endif %}{% if child.default %} =default{% endif %}{% if child.deleted %} =deleted{% endif %}{% if child.pureVirtual %} =0{% endif %} {% if existsIn(child, "brief") %}<br>{{child.brief}}{% endif %} |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 {% endfor %}{% endif %}
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 {% if exists("publicFunctions") %}## Functions
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
50
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 | | Name |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 | -------------- | -------------- |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 {% for child in publicFunctions %}| {% if existsIn(child, "templateParams") %}template \<{% for param in child.templateParams %}{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif %}{% if not loop.is_last %},{% endif %}{% endfor %}\></br>{% endif %}{% if child.virtual %}virtual {% endif %}{% if existsIn(child, "type") %}{{child.type}}{% endif %} | **[{{child.name}}]({{child.url}})**({% for param in child.params %}{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif %}{% if not loop.is_last %}, {% endif %}{% endfor %}){% if child.const %} const{% endif %}{% if child.override %} override{% endif %}{% if child.default %} =default{% endif %}{% if child.deleted %} =deleted{% endif %}{% if child.pureVirtual %} =0{% endif %} {% if existsIn(child, "brief") %}<br>{{child.brief}}{% endif %} |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 {% endfor %}{% endif %}
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 {% if exists("publicAttributes") %}## Attributes
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
56
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 | | Name |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 | -------------- | -------------- |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 {% for child in publicAttributes %}| {% if existsIn(child, "type") %}{{child.type}}{% endif %} | **[{{child.name}}]({{child.url}})** {% if existsIn(child, "brief") %}<br>{{child.brief}}{% endif %} |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 {% endfor %}{% endif %}
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 {% if exists("defines") %}## Defines
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
62
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 | | Name |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 | -------------- | -------------- |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 {% for child in defines %}| {% if existsIn(child, "type") %}{{child.type}}{% endif %} | **[{{child.name}}]({{child.url}})**{% if existsIn(child, "params") %}({% for param in child.params %}{{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif %}{% if not loop.is_last %}, {% endif %}{% endfor %}){% endif %} {% if existsIn(child, "brief") %}<br>{{child.brief}}{% endif %} |
f4dc208aa1e3 doc: improve readability
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 {% endfor %}{% endif %}