• Packages
  • Themes
  • Documentation
  • Blog
  • Discuss
Sign in

coffeedocs

Generate CoffeeScript documentation following the atom styleguide
maschs
1,158
13
  • Repo
  • Bugs
  • Versions
  • License
Flag as spam or malicious

CoffeeDocs

Build Status

Generate CoffeeScript documentation following the Atom documentation styleguide!

coffeedocs-generator

Features

  • Generate CoffeeScript documentation.
  • Comment indentation for a clean look.
  • Returns statement is configurable via template.

How to use

Place your active cursor on the line with the function definition. Press the assigned key or activate Coffeedocs: Generate from the command palette.

Returns template

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

Default Keybindings

  • :apple: cmd-alt-d
  • :checkered_flag: ctrl-alt-d
  • :penguin: ctrl-alt-shift-d

Contributions

Contributors are welcome! Take a look at the Atom contributing guide.

I think this package is bad news.

Good catch. Let us know what about this package looks wrong to you, and we'll investigate right away.

  • Terms of Use
  • Privacy
  • Code of Conduct
  • Releases
  • FAQ
  • Contact
with by