Generate CoffeeScript documentation following the Atom documentation styleguide!
Returns
statement is configurable via template.Place your active cursor on the line with the function definition. Press the assigned key or activate Coffeedocs: Generate
from the command palette.
You can set a custom template to use if Add Returns
is enabled.
Returns the %desc% as %type%.
(Default template)
What does this mean?
%desc%
will be replaced by the [description]
block.%type%
will be replaced by your default type: type
.%TYPE%
will be replaced by your default type in braces: {type}
.cmd-alt-d
ctrl-alt-d
ctrl-alt-shift-d
Contributors are welcome! Take a look at the Atom contributing guide.
Good catch. Let us know what about this package looks wrong to you, and we'll investigate right away.