apidoc/apidoc

Documentation for API

apiDoc 0.7.x

Generates a RESTful web API Documentation., _(*1)

, _(*2)

Documentation at apidocjs.com., _(*3)

Example output., _(*4)

Installation

npm install apidoc -g, _(*5)

Example

javascript /** * @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. */, _(*6)

apidoc -i example/ -o doc/, _(*7)

Creates from input files in example/ a documentation in path doc/., _(*8)

Supported programming languages

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

  /**
   * This is a comment.
   */
  

• CoffeeScript:, _(*10)

  ###
  This is a comment.
  ###
  

• Erlang:, _(*11)

  %{
  This is a comment.
  %}
  

• Perl, _(*12)

  #**
  # This is a comment.
  #*
  

  =pod
  This is a comment.
  =cut
  

• Python, _(*13)

  """
  This is a comment.
  """
  

• Ruby, _(*14)

  =begin
  This is a comment.
  =end
  

Grunt Module

grunt-apidoc npm install grunt-apidoc., _(*15)

Changelog

CHANGELOG.md, _(*16)

Help

Please add issues if you have a question or found a problem. Pull requests are welcome too!, _(*17)

A chat about apiDoc is on Gitter., _(*18)

, _(*19)

License

Copyright (c) 2013-2014 inveris OHG, _(*20)

Author Peter Rottmann rottmann@inveris.de, _(*21)

Licensed under the MIT license., _(*22)