ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

CFMLDoc​Plugin

by MFernstrom ST2/ST3

A Sublime 2/3 plugin for generating JavaDoc/YUIDoc style comments in CFML (Both tags and script)

Details

Installs

  • Total 2K
  • Win 1K
  • OS X 249
  • Linux 98
Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7 Sep 6 Sep 5 Sep 4 Sep 3 Sep 2 Sep 1 Aug 31 Aug 30 Aug 29 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
Windows 1 3 0 3 2 0 0 1 1 0 0 0 0 0 0 2 0 0 0 1 2 3 1 1 2 0 0 0 0 1 1 0 1 0 1 1 1 0 3 1 1 0 0 0 1 1
OS X 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 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
Linux 0 0 0 0 0 0 0 0 0 0 0 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

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" }