broccoli-docco

#broccoli-docco Broccoli plugin for generating code documentation using Docco styled documentation blocks

NOTE: this is still a WIP, please not for use just yet :)

Installation

At the root of your development project type:

npm install broccoli-docco --save

Overview

This plugin leverages the popular docco documentation generator. This plugin can be used in your brocfile.js to identify tree's which should be documented. The primary method that will be exposed on this class is the document function:

function document(inputTree, options) {  }

Usage in the Brocfile would look something like:

var docco = require('broccoli-docco').DoccoBroc;
docco.document('src');

In the example above this would look for all supported document types in the src directory and create documentation in the docs directory (the default location).

Options

broccoli-docco's document method proxies the options hash to Docco. So you might have something like:

var docco = require('broccoli-docco').DoccoBroc;
var doccoOptions = {
	layout: 'parallel',
	output: 'docs',
	css: 'myCustomCSS.css'
};
docco.document('src', doccoOptions);

For more information about options parameteres refer to the Docco documentation.

Code Documentation

It would be odd to write code that documents code and then not document it ... so if you want to see the resultant documented code you can find it here:

broccoli-docco

Happy trails,

Ken Snyder