apiDoc creates a documentation from API annotations in your source code. apiDoc gives you the ability to attach a version number to an API so you can easily track changes between versions. Creates an apiDoc of all files within dir myapp/, uses template from dir mytemplate/ and put all output to dir apidoc/. Without any parameter, apiDoc generate a documentation from all .cs .dart .erl .go .java .js .php .py .rb .ts files in current dir (incl. subdirs) and writes the output to ./doc/. apiDoc include a default template which uses handlebars, Bootstrap, RequireJS and jQuery for the output of the generated api_data.js and api_project.js as a html-page. By default the generated apiDoc use a complex Template, which supports versioning, to view different versions of your API, and comparing, to view changes between two versions of your API. You can create your own template and use the apiDoc generated files.
Features
- apiDoc can be extended with your own parameters
- The optional apidoc.json in your projects root dir includes common information about your project
- Disable browser language auto-detection and set a specific locale
- In your projects apidoc.json you can add a header and footer
- Using inherit, you can define reusable snippets of your documentation
- You can maintain the documentation for all previous versions and the latest version of the API
Project Samples
Categories
DocumentationLicense
MIT LicenseFollow apiDoc
With Docmosis you can quickly and easily add document generation and reporting to your software application.