Skip to content
Peter Rottmann edited this page Apr 15, 2016 · 28 revisions

Functionality

  • Add a warning / error if same name, group and version is used multiple times https://github.com/apidoc/apidoc/issues/433

  • Keep order of inherited fields https://github.com/apidoc/apidoc/issues/333

  • Allow direct packageInfo insertion https://github.com/apidoc/grunt-apidoc/issues/18

  • Add an option to parse only the specific folder without subfolder.

  • Classmap, to select which methods should be documented.

  • Warning on wrong input file encoding.

  • Multi inheritance #194

  • Add split api-data and dynamic loading.

  • Add @apiDeprecated

  • Allow multiple comments blocks, not only one per method (for in-code documentation)

  • Ajax-File-Loading @apiSuccessExample json file://response.json

  • Think about @apiChangelog#141

  • ADD response headers e.g. @apiSuccessHeader (Success 201) {type} fieldname Some text. #139

  • Think about adding @apiSuccessDescription and @apiErrorDescription #138

  • Add apiAuthor (local) and/or global setting in apidoc.json

  • Output a warning on duplicate @apiName and any other duplicate var that should used once.

  • πŸ†— Revisit silent / verbose CLI parameter, default output should show only needed informations

  • πŸ†— 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.

    • Extend apidoc.json to include other files in navigation.
  • Add ability for file inclusion in all Description fields, e.g. @./dir/file.md

  • Fix: sorting "compare with prevoius" list is wrong.

  • πŸ†— Simple call of API-Methods from generated documentation (but iam not 100% sure about that)

  • πŸ†— 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

  • πŸ†— Role based parameters and return data (for admins, for endusers)

  • πŸ†— Simplify @apiName and @apiGroup with autofill from @api

Parser

  • Check to replace parser engine with jison or other matching engines

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)

Clone this wiki locally