apidoc

apiDoc 0.9.x

Generates a RESTful web API Documentation.

Changes from previous version visit CHANGELOG.md

apiDoc creates a documentation from API descriptions in your source code.

Documentation at apidocjs.com.

Example output.

Installation

npm install apidoc -g

Changelog

CHANGELOG.md

Example

/**
 * @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/.

More examples and best practice hints: EXAMPLES.md

Supported programming languages

• 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 Module

grunt-apidoc npm install grunt-apidoc.

Help

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

A chat about apiDoc is on Gitter.

License

Copyright (c) 2013-2014 inveris OHG

Author Peter Rottmann [e-mail]

Licensed under the MIT license.

Changelog

0.9.1

• Parser

  • Allow overwrite of packageInfo e.g. from grunt task (https://github.com/apidoc/apidoc/pull/177)

• Bugfix: Extend parser regexp to allow inline comment-code (https://github.com/apidoc/apidoc/pull/180)

• Bugfix: Slash only path in api triggered error (https://github.com/apidoc/apidoc/pull/159)

• Bugfix: Scrollspy offset (https://github.com/apidoc/apidoc/pull/176)

• Bugfix: Get package infos from package.json or apidoc.json (https://github.com/apidoc/apidoc/pull/169)