Create sourcecode documentation from Javascript and LESS/CSS files
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.loadNpmTasks('grunt-doxydoc');
In your project's Gruntfile, add a section named doxydoc
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
doxydoc: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
});
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.
Type: Object
Defines or overrides local variables they are passed to the templates
{
locals: {
customCSS: ['my/custom.css'],
customJS: ['my/custom.js']
}
}
Type: Object
Read configuration from instead of doxydoc.json
{
doxydocFile: '../myproject/doxydoc.json'
}
grunt.initConfig({
doxydoc: {
dist: {
options: {
},
src: ['src/**/*.js', 'less/**/*.less'],
dest: 'docs/index.html'
}
});