UNPKG

moxygen

Version:

Doxygen XML to Markdown converter

0state.com/moxygen

sourcey/moxygen

100 lines (76 loc) • 2.04 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
{{headingMarker 1}} API Reference {{#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}} {{#each members}} {{cleanAnchor refid name}} {{headingMarker 3}} {{name}} ```java {{signature}} ``` {{briefdescription}} {{#if enumvalue}} | Value | Description | |-------|-------------| {{#each enumvalue}}| `{{name}}` | {{summary}} | {{/each}} {{/if}} {{detaileddescription}} {{#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}} {{/each}} {{/each}}