-
Notifications
You must be signed in to change notification settings - Fork 0
ToDo
-
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
@apiSuccessDescriptionand@apiErrorDescription#138 -
Add
apiAuthor(local) and/or global setting inapidoc.json -
Output a warning on duplicate
@apiNameand any other duplicate var that should used once. -
π
Revisit silent / verbose CLI parameter, default output should show only needed informations -
π
Extend@apiExamplewith 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@apiParamTitleshould 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
- Check to replace parser engine with jison or other matching engines
- Better navigation for many navpoints
- Parameter enhancement:
- π
Markdown integration in multiline Descriptions - Include or reference of big example files (clearer reduced source code)
- π