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

CFMLDoc​Plugin

by MFernstrom ALL

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

Details

Installs

  • Total 2K
  • Win 2K
  • Mac 365
  • Linux 156
Feb 7 Feb 6 Feb 5 Feb 4 Feb 3 Feb 2 Feb 1 Jan 31 Jan 30 Jan 29 Jan 28 Jan 27 Jan 26 Jan 25 Jan 24 Jan 23 Jan 22 Jan 21 Jan 20 Jan 19 Jan 18 Jan 17 Jan 16 Jan 15 Jan 14 Jan 13 Jan 12 Jan 11 Jan 10 Jan 9 Jan 8 Jan 7 Jan 6 Jan 5 Jan 4 Jan 3 Jan 2 Jan 1 Dec 31 Dec 30 Dec 29 Dec 28 Dec 27 Dec 26 Dec 25
Windows 0 0 0 0 0 1 0 0 3 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 1 0 0 0 0 0 4 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 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 1 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" }