Typedef
Static Public Summary | ||
public |
|
|
public |
|
|
public |
|
|
public |
Parsed doc comment. |
|
public |
|
|
public |
ESDocCLI uses argv |
|
public |
ESDoc config object. |
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
doc comment tag. |
Static Public
public ESDocConfig: Object source
ESDoc config object.
Properties:
Name | Type | Attribute | Description |
source | string |
|
directory path of javascript source code. |
destination | string |
|
directory path of output. |
title | string |
|
|
includes | string[] |
|
|
excludes | string[] |
|
|
access | string[] |
|
"protected"]] |
autoPrivate | boolean |
|
|
builtinExternal | boolean |
|
|
unexportIdentifier | boolean |
|
|
undocumentIdentifier | boolean |
|
|
coverage | boolean |
|
|
debug | boolean |
|
|
index | string |
|
|
package | string |
|
|
importPathPrefix | string |
|
|
styles | string[] |
|
|
scripts | string[] |
|
|
test | {type: string, source: string, includes: string[], excludes: string[]} | ||
manual | Object |
|
|
manual.asset | string | ||
manual.overview | string[] | ||
manual.installation | string[] | ||
manual.usage | string[] | ||
manual.tutorial | string[] | ||
manual.configuration | string[] | ||
manual.example | string[] | ||
manual.faq | string[] | ||
manual.changelog | string[] |