apidoc/apidoc

There is no license information available for the latest version (dev-master) of this package.

Documentation for API

dev-master 2014-09-26 18:43 UTC

Requires

• php: >=5.3.0

Unknown License

README

Generates a RESTful web API Documentation.

Documentation at apidocjs.com.

Example output.

Installation

npm install apidoc -g

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

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.

Changelog

CHANGELOG.md

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.