YUIDoc Class
YUIDoc main class
var options = {
paths: [ './lib' ],
outdir: './out'
};
var Y = require('yuidoc');
var json = (new Y.YUIDoc(options)).run();
Constructor
YUIDoc
-
config
Parameters:
-
config
ObjectThe config object
Item Index
Methods
_processConfig
()
private
Does post process on self.options.
_setDefaultExcludes
()
private
Always exclude these directories
parsedir
-
dir
Walks the passed directory and grabs all the files recursively.
Parameters:
-
dir
StringThe directory to parse the contents of.
parsefiles
-
dir
-
files
Gathers all the file data and populates the filemap and dirmap hashes.
Parameters:
-
dir
StringThe directory to start from.
-
files
ArrayList of files to parse.
run
()
Object
Process the config, walk the file tree and write out the JSON data.
Returns:
The JSON data returned from the DocParser
walk
()
private
Walks the paths and parses the directory contents
writeJSON
-
parser
Writes the parser JSON data to disk.
Parameters:
-
parser
ObjectThe DocParser instance to use
Returns:
The JSON data returned from the DocParser
Properties
dirmap
Object
private
Holder for the list of directories we are processing.
endtime
Timestamp
Timestamp holder so we know when YUIDoc has finished the parse process.
filecount
Boolean
private
Holds the number of files that we are processing.
filemap
Object
private
Holder for the list of files we are processing.
OPTIONS
Object
final
The default list of configuration options
options
Object
private
Internal holder for configuration options.
selleck
Object
private
Hash map of dirnames to selleck config options.
starttime
Timestamp
Timestamp holder so we know when YUIDoc started the parse process.