UNPKG

firedoc

Version:

API Doc generator rewritten from [YUIDoc](https://github.com/yui/yuidoc). We use this tool to document a large JavaScript game engine [Fireball](http://github.com/fireball-x/fireball) at [docs-zh.fireball-x.com/api](http://docs-zh.fireball-x.com/api/) and

github.com/fireball-x/firedoc

fireball-x/firedoc

152 lines (63 loc) • 2.59 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
# firedoc 1.8.7 test ### `ThirdClazz` Class Extends `ClazzExample` Defined in: [test/targets/class/index.js:72](../files/test/targets/class/index.js.js) Module: [utils](../modules/utils.md) Parent Module: [undefinedmodule](../modules/undefinedmodule.md) ### Index ##### Properties - [`name`](#property-name) `String` The prop 1 - [`name2`](#property-name2) `Object` The name2 ##### Methods - [`method1`](#method-method1) method1 description - [`method2`](#method-method2) method2 description ##### Events - [`evt1`](#event-evt1) event ex ### Inherited members ##### Properties - [`name`](#property-name) - [`name2`](#property-name2) ##### Attributes ##### Methods - [``](#method-method1) - [``](#method-method2) ##### Events - [`evt1`](#event-evt1) ### Details #### Properties ##### name > The prop 1 | meta | description | |------|-------------| | Type | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | | Defined | [test/targets/class/index.js:8](../files/test_targets_class_index.js.md#l8) | ##### name2 > The name2 | meta | description | |------|-------------| | Type | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | | Defined | [test/targets/class/index.js:12](../files/test_targets_class_index.js.md#l12) | <!-- Method Block --> #### Methods ##### method1 method1 description | meta | description | |------|-------------| | Defined | [test/targets/class/index.js:18](../files/test_targets_class_index.js.md#l18) | | Return | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a> ###### Parameters - name <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> ##### method2 method2 description | meta | description | |------|-------------| | Defined | [test/targets/class/index.js:25](../files/test_targets_class_index.js.md#l25) | #### Events ### `evt1` Event Defined in: [test/targets/class/index.js:60](../files/test_targets_class_index.js.md#l60) Module: [utils](../modules/utils.md) Parent Module: [undefinedmodule](../modules/undefinedmodule.md) event ex ### Index ### Details