Class YUIDoc
Class defined in:lib/yuidoc.js:41
YUIDoc main class
var options = {
paths: [ './lib' ],
outdir: './out'
};
var Y = require('yuidoc');
var json = (new Y.YUIDoc(options)).run();
parsedir
( dir
) /* private method */
lib/yuidoc.js:110
Walks the passed directory and grabs all the files recursively.
Parameters:-
dir
<String> The directory to parse the contents of.
parsefiles
( dir, files
) /* private method */
lib/yuidoc.js:139
Gathers all the file data and populates the filemap and dirmap hashes.
Parameters:
Object
run
(
)
lib/yuidoc.js:199
Process the config, walk the file tree and write out the JSON data.
Returns: <Object> The JSON data returned from the DocParser
Object
writeJSON
( parser
) /* private method */
lib/yuidoc.js:169
Writes the parser JSON data to disk.
Parameters:-
parser
<Object> The DocParser instance to use
Returns: <Object> The JSON data returned from the DocParser
endtime
<Timestamp>lib/yuidoc.js:223
Timestamp holder so we know when YUIDoc has finished the parse process.
starttime
<Timestamp>lib/yuidoc.js:205
Timestamp holder so we know when YUIDoc started the parse process.