• Packages
  • Themes
  • Documentation
  • Blog
  • Discussions
Sign in

language-apidoc

ApiDoc syntax highlighting support in Atom, for any language
  • #apidoc
  • #api
  • #doc
  • #documentation
  • #language
almic
0.2.2 542
1
  • Repo
  • Bugs
  • Versions
  • License
Flag as spam or malicious

apiDoc highlighting for Atom

Because tree-sitter is still in development, this pacakge will disable JSDoc highlighting in apiDoc comment blocks. If this is causing problems for you, the only solution is to disable tree-sitter in your settings.

Also, Python is broken. I really don't understand why. Trying to get this fixed ASAP

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
  • 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
 */

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