apidoc - npm Package Versions

0.17.1

• Template
  • Fix missing type in template.
  • Add check for empty header/footer nav points.

0.17.0

Add new @apiDeprecated annotation. Add new @apiPrivate annotation.

• CLI

  • Add --private false|true parameter to export @apiPrivate marked methods.
  • Add .cls, .jsx, p, .pl, .vue file extensions.
  • Update dependencies.

• Parser

  • Add @apiDeprecated support. 52
  • Added support for private APIs @apiPrivate. 530
  • Add support for plugins in scoped modules. 51
  • Remove deprecated lib wrench and replace with fs-extra.
  • Update dependencies.

• Template

  • Update Bootstrap to 3.3.7.
  • Navigation filter added. 562
  • h2 links in Header / Footer files will now be visible in the main navigation. 525
  • Fix issue of left menu displaying major function in older version. 528
  • Replace lodash with only needed custom build lodash functions.
  • Update italian language file. 507

0.16.0

Greatest improvement: Plugin support

apidoc search now in global node modules dir and local node_modules for modules that start with apidoc-plugin-. (local installed plugins have higher priority)

View / clone: apidoc-plugin-test With a plugin you can add features like new parsers (this was possible before only with CLI param) or filters and workers.

Start adding hooks. Hooks can be used in plugins to extend or transform data.

If you need a hook in apidoc-core please add your hook and provide a pull request. How to add a hook into apidoc-core view source code

• CLI

  • Update dependencies.
  • Remove not needed js-cookie module.
  • Allow for single source configuration. 458

• Parser

  • Add Plugin Loader. Extend filter, parser, worker for plugin usage. example plugin
  • Add plugin hooks for found elements. available hooks
  • Add support for other encodings (default ist uf8). apidoc --encoding utf8
  • Add Lua support.
  • Add cpp support.
  • Add Arduino support.

• Template

  • Do not use monospace for sans-serif fonts, only code fonts.
  • Sort field by grouping. 457
  • Add X-UA-Compatible for Internet Explorer to prevent loading only screen.
  • Reformat JSON example output.
  • Example table column widths set to 100%.
  • Add Italian translation.

0.15.1

• Parser
  • Bugfix: Inherit error of lodash merge / mergeWidth split.

0.15.0

• CLI

  • Update dependencies.

• Parser

  • Upgrade markdown parser to version 0.6.

• Template

  • Make ajaxRequest simpler. 384
  • Format response json. 396
  • Improve sendSampelRequest. 400
  • Add Catalan translation. 403
  • Bugfix: zh_cn translation string. 415
  • Bugfix: Template break on defined prototype methods.
  • Update json response css.
  • Update webfontloader.
  • Add monospace font fallback.

0.14.0

• CLI

  • Clarify that -c option must be a directory.

• Parser

  • Add support for : in @apiParam names.
  • Add Ruby doxygen-style support.
  • Add Groovy support.
  • Add Exlixir support.
  • Add Parameter name array syntax.
  • Add travis-ci tests for node 0.12.

• Template

  • Add semver for correct sort order. 335
  • Add google webfontloader to fix scrollspy position after webfont loading.
  • Add semver for correct sort order.
  • Add Spanish translation.
  • Add Chinese Simplified (zh-cn) tranlsation.
  • Update to semantic tradition Chinese words.
  • Update Polish translation.
  • Ensure params isn't empty before sending.
  • Set required defaults for sample request.
  • Bugfix: Locale don't work with pt-br. 329
  • Bugfix: Empty Groups for Future Versions showing when old Versions are selected. 349
  • Bugfix: Add path to template variable (_col1).
  • Sample requests with GET parameters need to be added to the query string.
  • Fix handle bar expression to not apply html encode for data type field.
  • Typo in header.md.

0.13.2

• Parser
  • Remove p-Tags from type-Field.
  • Update dependencies.
  • Update fixtures (type-Fields and line endings).

0.13.1

• Template
  • Update French and Russian translation files.

0.13.0

• Important changes:

  • Remove deprecated annotations (http://apidocjs.com/deprecated.html).
  • Replace markdown parser markdown-it.

• CLI

  • Add path to config file (with -c).
  • Add multiple input locations (with -i).
  • Remove markdown config parameters, for custom configurations view MARKDOWN.md.
  • Disable warning if packageJson.apidoc was defined.
  • Add litcoffee and scala file extension.

• Template

  • Add template.forceLanguage in apidoc.json to set a fixed language file without auto-detect the browser language.
  • Add word wrap for pure text examples.
  • Add Brazilian, French, Polish and Russian translation files.

• Parser

  • Remove deprecated annotations (http://apidocjs.com/deprecated.html).
  • Replace markdown parser with markdown-it.
  • Add custom markdown parser support, view MARKDOWN.md for details.
  • Add support for markdown in the type section. Example: @apiParam {(CustomType)[http://...link-to-description.html]}