/**
* @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.
#*
```
Python
```
"""
This is a comment.
"""
```
Ruby
```
=begin
This is a comment.
=end
```

Grunt Module

grunt-apidoc npm install grunt-apidoc.

Changelog

CHANGELOG.md

License

0.6.0

Enable markdown for all description fields.
Add apidoc.json configuration file for primary configuration over package.json. (http://apidocjs.com/#configuration)
Add template specific configuration settings. (http://apidocjs.com/#configuration-template-settings)
Add support for Perl (Doxygen) comment-style.
Add simple CSS3 preloader.

Keywords

FAQs

What is apidoc?

Is apidoc popular?

Is apidoc well maintained?

Package last updated on 10 Jul 2014

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install