Creates documentation for your source code using Dox
This plugin requires Grunt
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-dox --save-dev
The "dox" task
In your project's Gruntfile, add a section named
dox to the data object passed into
The language style to use when parsing comments. Current possible values are
The output format for your documentation files. The standard is markdown files, but you can also output HTML or the raw
comment JSON generated by Dox. Current possible values are
In this example, we generate docs for a set of PHP library files. Markdown files will be created in the
docs folder with
the same folder structure as the source files.
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.