Generates a RESTful web API Documentation.

Documentation at apidocjs.com.

Example output.

npm install apidoc -g

/** * @api {get} /user/:id Request User information * @apiName GetUser * @apiGroup User * * @apiParam {Number} id Users unique ID. * * @apiSuccess {String} firstname Firstname of the User. * @apiSuccess {String} lastname Lastname of the User. */

apidoc -i example/ -o doc/

Creates from input files in example/ a documentation in path doc/.

• C#, Go, Dart, Java, JavaScript, PHP (all DocStyle capable languages):

  /**  * This is a comment.  */

• CoffeeScript:

  ### This is a comment. ###

• Erlang:

  %{ This is a comment. %}

• Perl

  #** # This is a comment. #*

  =pod This is a comment. =cut

• Python

  """ This is a comment. """

• Ruby

  =begin This is a comment. =end

grunt-apidoc npm install grunt-apidoc.

CHANGELOG.md

Please add issues if you have a question or found a problem. Pull requests are welcome too!

A chat about apiDoc is on Gitter.

Copyright (c) 2013-2014 inveris OHG

Author Peter Rottmann rottmann@inveris.de

Licensed under the MIT license.