Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
68 lines (28 sloc) 1.87 KB

#writeme

##File: lib/buildConfig.js

###function module.exports(cb) cb: Function completion callback. Signature: function (err)

Build self.config, call cb on completion.

Default config include array includes all .js files found in root, excluding the
default ignore list and files/directories prefixed with '.'

All config paths are relative to root where writeme is run.

Config options

include: array of files to document (all other files will be ignored)
template_path: path to mustache template to use for rendering docs
css_path: path to css file to use for docs (defaults to gfm)
doc_base: basename of docs output.
All docs will be output to two files with the doc_base string as the basename.
(eg. a value of readme will output a readme.md & readme.html)

##File: lib/generateDocs.js

###function module.exports(cb) cb: function completion callback. Signature: function (err)

Traverse down the root and run .renderDoc() as files are discovered.

##File: lib/initializeDoc.js

###function module.exports(cb) cb: Function completion callback. Signature: function (err)

initialize html doc (write css) & delete markdown file (if exists)

##File: lib/renderDocs.js

###function module.exports(files) files: array array of absolute paths of files to document

Run dox on files, render markdown & html, then write to doc files

##File: lib/writeme.js

###function Writeme(root) root: String absolute path to the directory (or file) to be documented

Writeme class

Sets up writeme configuration, and kicks off the doc generation

###Writeme.prototype

Attach prototype methods from lib directory