apiDoc highlighting for Atom

The official unofficial atom grammar package for apiDoc. Install this and it just works. No extra setup neccessary.

• apm install language-apidoc

I found apiDoc and was surprised it didn't have an Atom grammar yet, so I made it.

This should automatically work with any languages that support block comments for documentation. Since this injects itself into anything that looks like a documentation block comment, it may misbehave with other packages the work inside comment blocks. You can simply disable the package if this becomes a problem.

Please open an issue if you find a language that isn't getting the right highlighting.

Supported languages:

• JavaScript
• CoffeeScript
• Python
• Ruby

Other languages may work as well, but these are guaranteed to work correctly.

Snippets

Also comes with a few snippets to make life easier.

apiDoc

/**
 * @api {get} /path title
 * @apiVersion 0.0.0
 * @apiName
 * @apiGroup
 */

apiDefine

/**
 * @apiDefine Name Title
 * Description
 * @apiVersion 0.0.0
 */