CFMLDocPlugin
A Sublime 2/3 plugin for generating JavaDoc/YUIDoc style comments in CFML (Both tags and script)
Details
Installs
- Total 2K
- Win 2K
- Mac 362
- Linux 154
Aug 28 | Aug 27 | Aug 26 | Aug 25 | Aug 24 | Aug 23 | Aug 22 | Aug 21 | Aug 20 | Aug 19 | Aug 18 | Aug 17 | Aug 16 | Aug 15 | Aug 14 | Aug 13 | Aug 12 | Aug 11 | Aug 10 | Aug 9 | Aug 8 | Aug 7 | Aug 6 | Aug 5 | Aug 4 | Aug 3 | Aug 2 | Aug 1 | Jul 31 | Jul 30 | Jul 29 | Jul 28 | Jul 27 | Jul 26 | Jul 25 | Jul 24 | Jul 23 | Jul 22 | Jul 21 | Jul 20 | Jul 19 | Jul 18 | Jul 17 | Jul 16 | Jul 15 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | 0 | 2 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Mac | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Linux | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Readme
- Source
- raw.githubusercontent.com
cfmldocplugin - version 0.1.3
A Sublime plugin for generating CFDoc comments in CFML (Both tags and script)
Simple and straight forward, you simply install the plugin and set a shortcut key.
Running it will create CFDoc style comments based off of your CFML code.
While it automatically pulls in information about the code, it's not quite psychic yet, so to add comments to the header, simply use the hint or description!
So for example:
public array function myAwesomeFunction( required string awesome, maybeAwesome = "totally" ) hint="My text here" {
return arguments.awesome;
}
becomes:
/**
* My text here
*
* @method myAwesomeFunction
* @public
* @param {string} awesome (required)
* @param {any} [maybeAwesome = "totally" ]
* @return {array}
*/
public array function myAwesomeFunction( required string awesome, maybeAwesome = "totally" ) hint="My text here" {
return arguments.awesome;
}
The output comment blocks are pretty standard, I've tested with YUIDoc but not JavaDoc for generating documentation from it, and of course tested with the cfml documentation generator I'm about to release.
If you find bugs please let me know so I can take a look at it.
Installing
Install with the Sublime Package Manager, under CFMLDocPlugin
Set up a key shortcut to the command docifycfml, like so:
{ "keys": ["ctrl+shift+2"], "command": "docifycfml" }