Generates a RESTful web API Documentation.
Documentation at apidocjs.com.
Example output.
npm install apidoc -g
apidoc -i example/ -o doc/
Creates from input files in example/ a documentation in path doc/.
-
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
grunt-apidoc npm install grunt-apidoc.
Copyright (c) 2013 inveris OHG Author Peter Rottmann [email protected] Licensed under the MIT license.