Generate CoffeeScript documentation following the Codo style.
A fork of Coffeedoc by Maximilian Schüßler.
Returns
statement is configurable via template.Place your active cursor on the line with the function definition. Press the assigned key (default ctrl-alt-d) or activate Codo: Generate
from the command palette.
You can set a custom template to use if Add Returns
is enabled.
@return %type% %desc%
(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}
.Good catch. Let us know what about this package looks wrong to you, and we'll investigate right away.