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

46 lines (19 loc) • 640 B
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
# firedoc 1.8.7 test ## `firedoc` Module Defined in [lib/firedoc.js:2](../files/lib_firedoc.js.md#l2) ### Classes - [DocParser](../classes/DocParser.md) - [AST](../classes/AST.md) - [BuilderContext](../classes/BuilderContext.md) - [ParserContext](../classes/ParserContext.md) - [DocView](../classes/DocView.md) - [Firedoc](../classes/Firedoc.md) - [Locals](../classes/Locals.md) ### Enums ### Direct Members ### Index ##### Properties - [`NATIVES`](#property-natives) `Object` List of native types to cross link to MDN ##### Methods - [`parse`](#method-parse) parse and generate the `AST` object