YUIDoc

API Docs for: 0.1.0

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();
YUIDoc ( config )
lib/yuidoc.js:41 Parameters:
  • config <Object> The config object
_processConfig ( ) /* private method */
lib/yuidoc.js:91

Does post process on self.options.

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:
  • dir <String> The directory to start from.
  • files <Array> List of files to parse.
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
walk ( ) /* private method */
lib/yuidoc.js:100

Walks the paths and parses the directory contents

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
dirmap <Object>
lib/yuidoc.js:72

Holder for the list of directories we are processing.

endtime <Timestamp>
lib/yuidoc.js:223

Timestamp holder so we know when YUIDoc has finished the parse process.

filecount <Boolean>
lib/yuidoc.js:58

Holds the number of files that we are processing.

filemap <Object>
lib/yuidoc.js:65

Holder for the list of files we are processing.

OPTIONS <Object> (final)
lib/yuidoc.js:23

The default list of configuration options

options <Object>
lib/yuidoc.js:80

Internal holder for configuration options.

starttime <Timestamp>
lib/yuidoc.js:205

Timestamp holder so we know when YUIDoc started the parse process.