Home

Welcome to the apiDoc wiki!

Visit http://apidocjs.com for docs and examples.

Changelog is here

ToDo: Functionality

• Extend @apiExample with an optional type (e.g. JS, CURL, Ruby, ...) and add different views in the template
• Add @apiDocument {(before|after}:group} [Nav-Title] Description
• Add ability for file inclusion in all Description fields, e.g. @./dir/file.md
• Remove: package.js apidoc entries (not needed if @apiDocument is implemented)
• Fix: sorting "compare with prevoius" list is wrong.
• Simple call of API-Methods from generated documentation (but iam not 100% sure about that)
• Code Review
• Check if @apiParamTitle should be global function or local with versioning, at the moment it is global
• Multiple Structure usage
• Simplify define and usage of structures, only one define and usage is necessary:
  • @apiDefineStructure, @apiDefineErrorStructure, @apiDefineSuccessStructure -> @apiDefineStructure
  • @apiStructure, @apiErrorStructure, @apiSuccessStructure -> @apiStructure

ToDo: Improve Template

• Better navigation for many navpoints
• Parameter enhancement:
  • Markdown integration in multiline Descriptions
  • Include or reference of big example files (clearer reduced source code)