UNPKG

moxygen

Version:

Doxygen XML to Markdown converter

0state.com/moxygen

sourcey/moxygen

152 lines (111 loc) • 3.32 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
141
142
143
144
145
146
147
148
149
150
151
152
{{cleanAnchor refid name}} {{headingMarker 1}} {{shortname name}} {{#if includes}} ```cpp #include <{{includes}}> ``` {{/if}} ```cpp {{classSignature}} ``` {{#if (sourceLabel)}}{{#if (sourceHref)}}[Defined in {{sourceLabel}}]({{sourceHref}}){{else}}Defined in {{sourceLabel}}{{/if}} {{/if}} {{#if basecompoundref}}> **Inherits:** {{#each basecompoundref}}{{linkedName name refid}}{{#unless @last}}, {{/unless}}{{/each}} {{/if}} {{#if derivedcompoundref}}> **Subclassed by:** {{#each derivedcompoundref}}{{linkedName name refid}}{{#unless @last}}, {{/unless}}{{/each}} {{/if}} {{briefdescription}} {{detaileddescription}} {{#if allMembers}} {{headingMarker 2}} List of all members | Name | Kind | Owner | |------|------|-------| {{#each allMembers}}| {{linkedName name refid}} | `{{kind}}` | {{#if inherited}}Inherited from {{linkedName owner ownerRefid}}{{else}}Declared here{{/if}} | {{/each}} {{/if}} {{#each inheritedMemberGroups}} {{headingMarker 2}} Inherited from {{linkedName name refid}} | Kind | Name | Description | |------|------|-------------| {{#each members}}| `{{kind}}` | {{linkedName name refid}} {{badges}} | {{cell (memberSummary this)}} | {{/each}} {{/each}} {{#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}} ``` {{#if (sourceLabel)}}{{#if (sourceHref)}}[Defined in {{sourceLabel}}]({{sourceHref}}){{else}}Defined in {{sourceLabel}}{{/if}} {{/if}} {{briefdescription}} {{detaileddescription}} {{#if referencedBy}} {{headingMarker 4}} Referenced by {{#each referencedBy}}- {{linkedName name refid}} {{/each}} {{/if}} {{#if references}} {{headingMarker 4}} References {{#each references}}- {{linkedName name refid}} {{/each}} {{/if}} {{#if reimplements}} {{headingMarker 4}} Reimplements {{#each reimplements}}- {{linkedName name refid}} {{/each}} {{/if}} {{#if reimplementedBy}} {{headingMarker 4}} Reimplemented by {{#each reimplementedBy}}- {{linkedName name refid}} {{/each}} {{/if}} {{#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}}