Bugfix: Multiple added url to api path after compared to other version. (apidoc#87)
Bugfix: Docs do not generate without optional @api [title]. (apidoc#82)
Bugfix: Escape example output in apiExample
, apiErrorExample
, apiSuccessExample
. (apidoc#78)
Changing font include to work on HTTPS.
Some refactors and bugfixes.
Enable markdown for all description fields.
Add apidoc.json
configuration file for primary configuration over package.json
. (http://apidocjs.com/#configuration)
Add template specific configuration settings. (http://apidocjs.com/#configuration-template-settings)
Add support for Perl (Doxygen) comment-style.
Add simple CSS3 preloader.
Add css for printing.
Bugfix: Template IE8 compatibility. (apidoc#69)
Update node version to 0.10.x.
Add optional custom browser title with apidoc.title
in package.json
.
Add optional url endpoint with apidoc.url
in package.json
.
Bugfix: Template scrollbug. (apidoc#64)
Add new Functions:
Remove package.json path apidocFilename
.
Change package.json path apidoc
.
Add apidoc.header
/ apidoc.footer
(with custom navigation titles). (http://apidocjs.com/#headerfooter)
Remove template basic (easier to maintain), the default template will be re-designed in a future version too.
Update template libraries.
Add test cases.
Preserve other files when copying template files to the destination output dir.
Added a short-circuit check. (apidoc#41)
Bugfix: Fix parsing of multiline string. (apidoc#34)
Add support for CoffeeScript comment-style.
Add support for other comment-style. Now apiDoc supports:
- Erlang
- JavaScript (JavaDoc-Style: e.g. also useable in C#, Go, Dart, Java, PHP, TypeScript)
- Python
- Ruby
Add some programming language test cases.
Remove german code comments.
Upgrade all used node modules.
Replace deprecated node-markdown with marked.
Add cli parameter for marked --marked-...
, watch all params with--help
.
Upgrade all used node modules.
Bugfix: executable line delimiters. (again).
Bugfix: Allow usage of structures and titles in the same block. (apidoc#21)
Give some indication, in case file listing with fails. (apidoc#20)
Allow multiple structure includes.
Split and extend test-files.
Bugfix: Fix parsing for empty lines and removing stars on data that spans over multiple lines. (apidoc#11)
Remove http:// link to make https compliant. (apidoc#10)
Extend Template with url-param "compare=1" to show the compare version on page view.
Bugfix: Minor fix with double structure examples.
Bugfix: Template not show @apiSuccessExample @apiErrorExample.
Bugfix: executable line delimiters.
Extend @apiParam
, @apiSuccess
, @apiError
with a grouping ability. Example @apiParam (group) varname
.
view @apiParam
Add new Functions:
Minor Template-Bugfixes.
Allow whitespace in apiName and apiGroup.
Bugfix: Filter for directories.
Update Node Modules to newer versions.
Add -e
exclude option for Files / Directories, example apidoc -e node_modules/
.
Bugfix: Check for a valid title in Template. (apidoc#7)
Bugfix: Whitespace before comment block. (apidoc#2)
Change templates, enable navigation scroll.
Add @apiIgnore.
Update grunt Modules.
Bugfix: OSX executable.
Official release.