API
means bees
)
bees (in Italian Let the code write your docs D:
Installation:
$ npm install bees
Example:
See test/file
Plugin:
You can extend Bees and add new keywords with a tiny plugin system (see lib/plugins
)
var bees = ;bees;console;
Now you can use it
/** * GET /:id * * @param id id of the user * @return user infos * @plugin hai lol*/
$ node plugin.js
[
{
method: 'GET',
path: '/:id',
params: { id: 'id of the user' },
return: 'user infos',
plugin: 'hai lol'
}
]
Reporters:
Reporters are a way to return formatted objects.
If we got this in eyes-reporter.js:
var inspector = ; module { return ;};
And we call bees just like this:
bees -R eyes-reporter <file>
We will get:
Cool eh?
To Do:
- Generate HTML from JSON
Tests:
$ npm test
Tests are written with Vows
License:
MIT