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 153
| May 22 | May 21 | May 20 | May 19 | May 18 | May 17 | May 16 | May 15 | May 14 | May 13 | May 12 | May 11 | May 10 | May 9 | May 8 | May 7 | May 6 | May 5 | May 4 | May 3 | May 2 | May 1 | Apr 30 | Apr 29 | Apr 28 | Apr 27 | Apr 26 | Apr 25 | Apr 24 | Apr 23 | Apr 22 | Apr 21 | Apr 20 | Apr 19 | Apr 18 | Apr 17 | Apr 16 | Apr 15 | Apr 14 | Apr 13 | Apr 12 | Apr 11 | Apr 10 | Apr 9 | Apr 8 | Apr 7 | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Windows | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 1 | 1 | 0 | 0 | 1 | 0 | 1 | 0 | 1 | 0 | 0 | 0 | 1 | 0 | 1 | 2 | 0 | 0 | 1 | 1 | 1 | 0 | 2 |
| 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 | 0 |
| Linux | 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 | 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" }