YUIDoc Class
YUIDoc main class
var options = {
paths: [ './lib' ],
outdir: './out'
};
var Y = require('yuidoc');
var json = (new Y.YUIDoc(options)).run();Constructor
Item Index
Methods
_processConfig
()
private
Does post process on self.options.
_setDefaultExcludes
()
private
Always exclude these directories
parsedir
(
private
-
dir
Walks the passed directory and grabs all the files recursively.
Parameters:
-
dirStringThe directory to parse the contents of.
parsefiles
(
private
-
dir -
files
Gathers all the file data and populates the filemap and dirmap hashes.
run
()
Object
Process the config, walk the file tree and write out the JSON data.
Returns:
Object:
The JSON data returned from the DocParser
runPreprocessors
()
Object
private
Applies preprocessors to the data tree. This function first clones the data and operates on the clone.
Returns:
Object:
The mutated data
walk
()
private
Walks the paths and parses the directory contents
Properties
endtime
Timestamp
Timestamp holder so we know when YUIDoc has finished the parse process.
starttime
Timestamp
Timestamp holder so we know when YUIDoc started the parse process.