grunt-doxydoc
Create sourcecode documentation from Javascript and LESS/CSS files
Getting Started
This plugin requires Grunt ~0.4.0
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-doxydoc --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
The "doxydoc" task
Overview
In your project's Gruntfile, add a section named doxydoc
to the data object passed into grunt.initConfig()
.
grunt;
Options
options.template
Type: String
Sets a custom template path. Uses the lagoon
tempalte as default
DoxyDoc comes with 2 predefined themes:
lagoon
tempalte is the default theme.
deep-space
an alternate dark theme.
options.locals
Type: Object
Defines or overrides local variables they are passed to the templates
locals: customCSS: 'my/custom.css' customJS: 'my/custom.js'
options.doxydocFile
Type: Object
Read configuration from instead of doxydoc.json
doxydocFile: '../myproject/doxydoc.json'
options.docuFilename
Type: Object
Defines a filename for the api documentation. Defaults to docu.html
docuFilename: 'apidocs.html'
options.livereload
Type: Boolean
or Number
Enables livereload support. Adds the livereload script tag to each page.
The value can be either a port number or a boolean. If value is true
the default port 35729
is using.
livereload: 35729
Usage Examples
grunt