A Grunt task plugin to generate documentation for Adobe Flex/ActionScript/MXML/FLV/etc. apps with the `asdoc` tool from the Apache/Adobe Flex SDK.
npm install grunt-asdoc> A Grunt task plugin to generate documentation for Adobe Flex/ActionScript/MXML/FLV/etc. apps with the asdoc tool from the Apache/Adobe Flex SDK.
~0.4.2If 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:
``shell`
npm install grunt-asdoc --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
`js`
grunt.loadNpmTasks('grunt-asdoc');
to the data object passed into grunt.initConfig().`js
grunt.initConfig({
asdoc: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
})
`$3
#### options.rawConfig
Type:
Default value: A string value that is used as the raw configuration for the
command line arguments, minus the input and output files.#### options.output
Type:
String
Default value: A string value that is used as the output directory. If a "dest" file is configured, it will override this
option.#### _(Other Options)_
For all other options, see the ASDoc Tool
documentation for further explanation.
$3
#### Basic example with src-dest file
`js
grunt.initConfig({
asdoc: {
example1: {
'docs/': ['src/example.as']
}
}
});
`
#### Basic example with
option`js
grunt.initConfig({
asdoc: {
options: {
/ output can be used in place of a "dest" option /
output: 'docs/'
},
example2: {
options: {
rawConfig: '-source-path .'
},
src: ['src/example.as']
}
}
});
`
#### Basic example with
and docSources options`js
grunt.initConfig({
asdoc: {
example3: {
/ output can be used in place of a "dest" option /
output: 'docs/',
/ docSources can be used in place of a "src" option /
docSources: ['src/example.as']
}
}
});
``