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

216 lines (96 loc) 4.25 kB
# firedoc 1.8.7 test ### `SecondClazz` Class Extends `ClazzExample` Defined in: [test/targets/class/index.js:30](../files/test/targets/class/index.js.js) Module: [utils](../modules/utils.md) Parent Module: [undefinedmodule](../modules/undefinedmodule.md) The second class ### Index ##### Properties - [`name`](#property-name) `String` The prop 1 - [`name2`](#property-name2) `Object` The name2 ##### Attributes - [`attr1`](#attribute-attr1) attribute - [`attr2`](#attribute-attr2) close attrubute ##### Methods - [`method2_with_description`](#method-method2_with_description) method2 description 2 - [`method1`](#method-method1) extended from class1 and rewritten in this class - [`method2`](#method-method2) method2 description ##### Events - [`evt1`](#event-evt1) event ex ### Inherited members ##### Properties - [`name`](#property-name) - [`name2`](#property-name2) ##### Attributes ##### Methods - [``](#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) | #### Attributes `attr1`: Unknown Defined in `test/targets/class/index.js:50` --------------------- attribute ##### Fires event `attr1Change` Fires when the value for the configuration attribute `attr1` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed. `attr2`: Unknown Defined in `test/targets/class/index.js:55` --------------------- close attrubute ##### Fires event `attr2Change` Fires when the value for the configuration attribute `attr2` is changed. You can listen for the event using the `on` method if you wish to be notified before the attribute's value has changed, or using the `after` method if you wish to be notified after the attribute's value has changed. <!-- Method Block --> #### Methods ##### method2_with_description method2 description 2 | meta | description | |------|-------------| | Defined | [test/targets/class/index.js:36](../files/test_targets_class_index.js.md#l36) | | Return | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> ###### Parameters - name <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> The name description ##### method1 extended from class1 and rewritten in this class | meta | description | |------|-------------| | Defined | [test/targets/class/index.js:43](../files/test_targets_class_index.js.md#l43) | | 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/Boolean" class="crosslink external" target="_blank">Boolean</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