Build the complete documentation: generate AST from the source files, then extracting doc objects from AST and finally buid HTML pages from the doc objects.
Build all the docs for the app and then build all the html files
| Name | Type | Description |
|---|---|---|
| sourceFilesList | Array of String | The source files names, including relative path since theConfig.srcDir |
A ClassDocBuilder object used by the class
The generated ClassDoc objects
A SourceHtmlBuilder object used by the class
A VariableDocBuilder object used by the class
The generated VariableDoc objects
Build all the docs for a file
| Name | Type | Description |
|---|---|---|
| ast | Object | The root ast node given by the babel/parser |
| sourceFileName | String | The source file name, including relative path since theConfig.srcDir |
Traverse the ast created by the Babel parser and extract the TagData objects for the template literals, string literals, regexp literals and comments
| Name | Type | Description |
|---|---|---|
| ast | Object | The root ast node given by the babel/parser |
| sourceFileName | String | The source file name, including relative path since theConfig.srcDir |