Skip to content
/ apidoc Public
forked from apidoc/apidoc

RESTful web API Documentation Generator

License

Notifications You must be signed in to change notification settings

wayt/apidoc

Repository files navigation

apiDoc

About

Generates a RESTful web API Documentation.

Docs and examples at apidocjs.com.

Installation

npm install apidoc -g

Example

apidoc -i example/ -o doc/ Creates from input files a documentation in path doc/.

Changelog

  • 0.1.10 Add -e exclude option for Files / Directories, example apidoc -e node_modules/.
  • 0.1.10 Fix check for a valid title in Template (Ben S. Stahlhood II apidoc#7)
  • 0.1.9 Fix for whitespace before comment block (Brandon Hamilton apidoc#2)
  • 0.1.8 Change templates, enable navigation scroll.
  • 0.1.7 Add @apiIgnore. Update grunt Modules.
  • 0.1.6 Fix OSX executable
  • 0.1.5 Official release

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