apidoc

RESTful web API Documentation Generator

npm install apidoc
46 downloads in the last day
349 downloads in the last week
987 downloads in the last month

apiDoc 0.4.x

Generates a RESTful web API Documentation.

Documentation at apidocjs.com.

Example output.

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.
    %}
    
  • Python

    """
    This is a comment.
    """
    
  • Ruby

    =begin
    This is a comment.
    =end
    

Installation

npm install apidoc -g

Example

apidoc -i example/ -o doc/

Creates from input files a documentation in path doc/.

Grunt Module

grund-apidoc npm install grunt-apidoc.

Changelog

CHANGELOG.md

License

Copyright (c) 2013 inveris OHG Author Peter Rottmann rottmann@inveris.de Licensed under the MIT license.

npm loves you