beandocs v0.0.2

Beandocs - documentation engine for beanpole

Built-in templates

• WADL
• README files (use to generate docs online)

Live examples

• Spice.io web console
• Spice.io docs

Usage

beandocs -i /path/to/project -o /output/directory -t /template

Syntax

 router.on({
 	
 	/**
	 * <My Super Long Description Here>
	 * @param <param name> <param description>
	 * @return <app return description>
	 * @see <ref to other documentation>
	 */

	
	'pull my/api/method/with/a/:param': function()
	{
		
	}

 })

Example

Your beanpole file:

var router = require('beanpole').router();

router.on({
	
	/**!
	 * Says hello world to the user
	 * @param name the name of the user to say hello to
	 */

	'pull -api say/hello/:name': function()
	{
		//stuff here....
	}

});

(optional) in your beanpole config located in same directory as package.json:

{
	"title": "My Project Title",
	"descscription": "My Project Description",
	"template":"template name or template/path",
	"meta": {
		"descriptions": {
			"api": "Public to the world and over HTTP."
		},
		"public": ["api","public","http"]
	},
	"method" {
		"pull": "Makes a request for current data.",
		"push": "Called when data has changed."
	}
}

in your console window:

beandocs -i /path/to/file