firedoc/out/classes/Firedoc.md

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

# firedoc 1.8.7

test

### `Firedoc` Class


Defined in: [lib/firedoc.js:23](../files/lib/firedoc.js.js)

Module: [utils](../modules/utils.md)
Parent Module: [firedoc](../modules/firedoc.md)




Firedoc main class

### Index

##### Properties

  - [`filecount`](#property-filecount) `Boolean` Holds the number of files that we are processing.
  - [`filemap`](#property-filemap) `Object` Holder for the list of files we are processing.
  - [`dirmap`](#property-dirmap) `Object` Holder for the list of directories we are processing.
  - [`options`](#property-options) `Object` Internal holder for configuration options.



##### Methods

  - [`walk`](#method-walk) Walks the paths and parses the directory contents
  - [`build`](#method-build) Process the config, walk the file tree and write out the JSON data.





### Details


#### Properties


##### filecount

> Holds the number of files that we are processing.

| meta | description |
|------|-------------|
| Type | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a> |
| Defined | [lib/firedoc.js:35](../files/lib_firedoc.js.md#l35) |



##### filemap

> Holder for the list of files we are processing.

| meta | description |
|------|-------------|
| Type | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> |
| Defined | [lib/firedoc.js:42](../files/lib_firedoc.js.md#l42) |



##### dirmap

> Holder for the list of directories we are processing.

| meta | description |
|------|-------------|
| Type | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> |
| Defined | [lib/firedoc.js:49](../files/lib_firedoc.js.md#l49) |



##### options

> Internal holder for configuration options.

| meta | description |
|------|-------------|
| Type | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> |
| Defined | [lib/firedoc.js:57](../files/lib_firedoc.js.md#l57) |






<!-- Method Block -->
#### Methods


##### walk

Walks the paths and parses the directory contents

| meta | description |
|------|-------------|
| Defined | [lib/firedoc.js:133](../files/lib_firedoc.js.md#l133) |



##### build

Process the config, walk the file tree and write out the JSON data.

| meta | description |
|------|-------------|
| Defined | [lib/firedoc.js:171](../files/lib_firedoc.js.md#l171) |

###### Parameters
- callback <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a>