npm install grunt-docco-dirGrunt Docco plugin, extension.
Docco takes a list of files and then generates documents based on all those files. If two or more files have the same name
then docco overwrites one of the files.
This plugin creates separate directories for the files based on the real directory. So if a file is in src/common/foo
it will end up in a directory called src.common.foo. This will allow 2 or more files, with the same name, in different directories,
to get documentation generated for both with no issues. This means you can have a widgets/Base.js and common/Base.js
and neither will get overwritten. This plugin also creates an actual index.html page. In a future version of this plugin,
that index will be customizable.
npm install grunt-docco-dir --save-devThen add this line to your project's grunt.js gruntfile:
``javascript`
grunt.loadNpmTasks('grunt-docco-dir');
[grunt]: https://github.com/cowboy/grunt
[getting_started]: https://github.com/cowboy/grunt/blob/master/docs/getting_started.md
Add the task config to the grunt initConfig block.
`
docco: {
debug: {
src: ['test/*/.js'],
options: {
output: 'docs/'
}
}
}
``