node-doc/doc/api.md

Node doc is a documenting tool. You can extract documentation from your source code and convert it into markdown, for easy use in for example GitHub.

# Api

### parser (Function)

> Access: public

Parses a file or a whole directory to an documententation. This can be outputted in an object or in Markdown (Github flavored).

```js
var parser = parser(input, [output], [options]);
```

#### Params

| Name | Type | Optional | Desciption |
| ---- | ---- | -------- | ---------- |
| input | String | False | The directory of the source files get documention from. |
| output | String | True | The directory to write the output to. |
| options | Object | True | Object with options |
| options.result | String | False | The type of result wanted: object or markdown. |
| options.private | Boolean | False | Wether or not to show private comments. |

#### Returns

| Name | Type | Desciption |
| ---- | ---- | ---------- |
| return | Object|String | Object or string (Markdown) with the results. |

### isDir (Function)

> Access: private

Check if file or dir is an directory.

```js
var isdir = isDir(input);
```

#### Params

| Name | Type | Optional | Desciption |
| ---- | ---- | -------- | ---------- |
| input | String | False | Directory or file, needs to end with '/'. |

#### Returns

| Name | Type | Desciption |
| ---- | ---- | ---------- |
| return | Boolean | Wether the input is a directory or not. |

### getFilesRecursive (Function)

> Access: private

Get all files in an directory recursive.

```js
var getfilesrecursive = getFilesRecursive(dir);
```

#### Params

| Name | Type | Optional | Desciption |
| ---- | ---- | -------- | ---------- |
| dir | String | False | Directory to get all file from. |

#### Returns

| Name | Type | Desciption |
| ---- | ---- | ---------- |
| return | Array | Array with files. |

### toMarkdownRecursive (Function)

> Access: private

Convert an object to markdown recursively.

```js
var tomarkdownrecursive = toMarkdownRecursive(doc);
```

#### Params

| Name | Type | Optional | Desciption |
| ---- | ---- | -------- | ---------- |
| doc | Object | False | Comment object from parse file. |

#### Returns

| Name | Type | Desciption |
| ---- | ---- | ---------- |
| return | Object | Object with markdown strings. |

### saveFileRecursive (Function)

> Access: private

Save a file recursively.

```js
saveFileRecursive(root, ext, doc);
```

#### Params

| Name | Type | Optional | Desciption |
| ---- | ---- | -------- | ---------- |
| root | String | False | Root directory. |
| ext | String | False | Extention to use. |
| doc | Object | False | Files with object keys as names. |

### recursiveCheck (Function)

> Access: private

Check if it's an recursive object.

```js
var recursivecheck = recursiveCheck(obj);
```

#### Params

| Name | Type | Optional | Desciption |
| ---- | ---- | -------- | ---------- |
| obj | Object | False | Possible recursive object. |

#### Returns

| Name | Type | Desciption |
| ---- | ---- | ---------- |
| return | Boolean | Wether or not it's recursive. |