UNPKG

moxygen

Version:

Doxygen XML to Markdown converter

0state.com/moxygen

sourcey/moxygen

140 lines (107 loc) • 2.99 kB
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
{{cleanAnchor refid name}} {{#if (eq kind "group")}} {{headingMarker 1}} {{#if this.shortname}}{{this.shortname}}{{else}}{{shortname name}}{{/if}} {{#with (groupBreadcrumbs this) as |breadcrumbs|}} {{#if breadcrumbs}} > {{#each breadcrumbs}}{{linkedName shortname refid}}{{#unless @last}} / {{/unless}}{{/each}} {{/if}} {{/with}} {{summary}} {{else}} {{headingMarker 1}} {{shortname name}} {{briefdescription}} {{detaileddescription}} {{/if}} {{#with (compoundsOfKind filtered.compounds "group") as |groups|}} {{#if groups}} {{headingMarker 2}} Groups | Name | Description | |------|-------------| {{#each groups}}| {{linkedName shortname refid}} | {{cell summary}} | {{/each}} {{/if}} {{/with}} {{#with (compoundsOfKind filtered.compounds "namespace") as |namespaces|}} {{#if namespaces}} {{headingMarker 2}} Namespaces | Name | Description | |------|-------------| {{#each namespaces}}| {{linkedName name refid}} | {{cell summary}} | {{/each}} {{/if}} {{/with}} {{#with (compoundsOfKind filtered.compounds "class" "struct" "interface") as |types|}} {{#if types}} {{headingMarker 2}} Classes | Name | Description | |------|-------------| {{#each types}}| {{linkedName name refid}} | {{cell summary}} | {{/each}} {{/if}} {{/with}} {{#with (compoundsOfKind filtered.compounds "enum") as |enums|}} {{#if enums}} {{headingMarker 2}} Enumerations | Name | Description | |------|-------------| {{#each enums}}| {{linkedName name refid}} | {{cell summary}} | {{/each}} {{/if}} {{/with}} {{#each filtered.sections}} {{headingMarker 2}} {{label}} {{#if (hasReturnColumn section)}} | Return | Name | Description | |--------|------|-------------| {{#each members}}| {{returnTypeShort}} | [`{{name}}`](#{{cleanId refid name}}) {{badges}} | {{cell (memberSummary this)}} | {{/each}} {{else}} | Name | Description | |------|-------------| {{#each members}}| [`{{name}}`](#{{cleanId refid name}}) {{badges}} | {{cell (memberSummary this)}} | {{/each}} {{/if}} {{#each members}} --- {{cleanAnchor refid name}} {{headingMarker 3}} {{name}} {{badges}} ```cpp {{signature}} ``` {{briefdescription}} {{detaileddescription}} {{#unless briefdescription}} {{#unless detaileddescription}} {{memberSummary this}} {{/unless}} {{/unless}} {{#if (hasDocumentedParams params)}} {{headingMarker 4}} Parameters | Parameter | Type | Description | |-----------|------|-------------| {{#each (documentedParams params)}}| `{{name}}` | `{{type}}` | {{description}} | {{/each}} {{/if}} {{#if returnValues}} {{headingMarker 4}} Return Values | Value | Description | |-------|-------------| {{#each returnValues}}| `{{name}}` | {{description}} | {{/each}} {{/if}} {{#if exceptions}} {{headingMarker 4}} Exceptions | Exception | Description | |-----------|-------------| {{#each exceptions}}| `{{name}}` | {{description}} | {{/each}} {{/if}} {{#if enumvalue}} | Value | Description | |-------|-------------| {{#each enumvalue}}| `{{name}}` | {{summary}} | {{/each}} {{/if}} {{/each}} {{/each}}