Extending docco to work on multi-folder structures and multiline comments
npm install docco-plus-multilineshell
sudo npm install -g docco-plus-multiline
`
$3
`shell
docco-plus-multiline [options] FILES
`
FILES can be a list of files or a glob pattern. When passing glob pattern make sure that they are enclosed by quotes.
$3
`shell
{
...
".js": {
"name": "javascript",
"inlineComment": "//",
"multiLineCommentStart": "/*",
"multiLineCommentEnd": "*/",
"removeMultiLineSpecial": [" ", "\r", "*\n"]
}
...
}
`
Use the header language file to support the multiline comment in languages other than js, html, css and scss
#### Options:
Options available for docco-plus-multiline are listed below, These options do the same thing as docco options. In fact, they are
passed as-is to the docco processor. Refer the Docco documentation on more details about these options.
- -h or --help output usage information
- -V or --version output the version number
- -c [file] or --css [file] use a custom css file
- -h [string] or --highlightStyle [string] use a highlightjs theme style. Styles are detailed here
- -o [path] or --output [path] use a custom output path
- -L [file] or --languages [file] use a custom languages.json
- -t [path] or --template [path] use a custom jst template file
- -m [file] or --marked [file] use custom marked options
- -i [file] or --index [file]` the file to be documented as the landing file for the documentation