Skip to content

Zambonilli/apidoc

 
 

Repository files navigation

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 [email protected] Licensed under the MIT license.

About

RESTful web API Documentation Generator

Resources

License

Stars

Watchers

Forks

Packages

No packages published