Skip to content

Latest commit

 

History

History
372 lines (223 loc) · 10.4 KB

CHANGELOG.md

File metadata and controls

372 lines (223 loc) · 10.4 KB
Raw

apiDoc Changelog

0.10.2

  • Parser
    • Add Clojure parser.

0.10.1

  • Bugfix: Path to apidoc-core.

0.10.0

  • Split apidoc code

    • apidoc is now only the CLI-Tool with UI-Template and file creation (as you know it). You can use apidoc without change anything.

    • apidoc-core (for developers) is the parser and response the api-data.

    • apidoc-example (for developers) are the test files for the apidoc-spec.

  • CLI

    • Replace optimist (not maintained anymore) with nomnom: true / false parameters can now be used, e.g. enable markdown (default) --markdown or disable --no-markdown.
    • Add parameter --markdown.
    • Replace the custom Logger with winston.

  • Parser

    • Bugfix: Settings to enable / disable markdown (marked-gfm was previously used).

  • Template

    • Add generator.url and generator.name to the footer generator information (for custom ui-generators).
    • Move handlebars_helper.js to utils/

  • Common

    • Remove grunt dependencies (test run with npm run test).
    • Change grunt-apidoc (0.10.0) to use always the latest version of apiDoc.

0.9.1

  • Parser

    • Allow overwrite of packageInfo e.g. from grunt task (apidoc#177)

  • Bugfix: Extend parser regexp to allow inline comment-code (apidoc#180)

  • Bugfix: Slash only path in api triggered error (apidoc#159)

  • Bugfix: Scrollspy offset (apidoc#176)

  • Bugfix: Get package infos from package.json or apidoc.json (apidoc#169)

0.9.0

  • CLI

    • Allow to include an external file which can set the markdown settings. (apidoc#166)

  • Template

    • Add custom order in apidoc.json Append apiName or apiGroup in the order list:

      "order": [
  "MyGroupName",
  "MyParameterName",
  "MyOtherParameterName"
]

    • Speed up rendering of subtemplates (apidoc#164)

    • Bugfix: Special char doesn't show in @apiGroup. (apidoc#163)

0.8.2

  • Bugfix: apiGroupDescription from apiDefine not working. (apidoc#156)
  • Bugfix: remove deprecated message for apiPermission. (apidoc#154)
  • Bugfix: Testclient did not send JSON format. (apidoc#152)

0.8.1

  • Bugfix: Python regex doublequote. (apidoc#151)
  • Bugfix: Issue with multiple apiSuccessExample blocks. (apidoc#150)

0.8.0

  • Parameter

    • Add as replacement for all (now) deprecated define and structure methods:

      • @apiDefine
      • @apiUse

    • Deprecated:

      • @apiDefineErrorStructure
      • @apiDefineHeaderStructure
      • @apiDefinePermission
      • @apiDefineStructure
      • @apiDefineSuccessStructure
      • apiErrorTitle
      • apiErrorStructure
      • apiHeaderStructure
      • apiHeaderTitle
      • apiParamTitle
      • apiStructure
      • apiSuccessTitle
      • apiSuccessStructure

    • Remove unneeded methods since success and error response can be grouped:

      • @apiInfo
      • @apiInfoExample
      • @apiInfoTitle

    • Add for consistent usage:

      • @apiHeaderExample
      • @apiParamExample

    • Change:

      • @apiPermission, multiple permission usage in a block is allowed now. Permission names must be defined with @apiDefine.

    • Extend:

      • @apiParam with size and allowed values.

  • CLI

    • Show deprecated message. Show details with --debug or --verbose.
    • Improved error output.
    • Turn off verbose output by default.
    • Add debug output.

  • Parser

    • Ignore other doc-language @-parameters (enables jsdoc, phpdoc, ... again).
    • Add apidoc specification version to project file.
    • Correctly handle Erlang comments.
    • Bugfix: Markdown error on Empty description.
    • Revised worker preProcess / postProcess functions.
    • Change parser export names.

  • Template

    • Show size and allowed values in field description.
    • Change template sample request to handle custom named groups.
    • Update template vendor files (handlebars 2, requirejs)
    • Added support for using path-to-regexp in sample request.
    • Add jQueryAjaxSetup to apidoc.json for setup ajax requests (http://apidocjs.com/#configuration-template-settings).
    • Hide the ul for tabs if no content.

0.7.2

  • Bugfix: Custom parsers not working. (apidoc#113)

0.7.1

  • Add type for @apiExample {type} Title, @apiSuccessExample, @apiErrorExample.
  • Add type switch in template.
  • Append filetype to fields at ajax reuqest testform.
  • Bugfix: Same file handling with regexp under win32. (apidoc#109)

0.7.0

  • Add rudimentary support for direct api calls (test requests) from within the doc.
  • Added ability to have forward slash (/) in parameter field names.
  • Add parameter --parse for parse only the files and return the parsed data.
  • Allow perl comments between "=pod" and "=cut".

0.6.5

  • Bugfix: Change RegExp for parameter values to handle all chars. (apidoc#97)

0.6.4

  • Bugfix: Reserved parameter names. (apidoc#96)

0.6.3

  • Bugfix: Multiple added url to api path after compared to other version. (apidoc#87)

0.6.2

  • Bugfix: Docs do not generate without optional @api [title]. (apidoc#82)
  • Bugfix: Escape example output in apiExample, apiErrorExample, apiSuccessExample. (apidoc#78)

0.6.1

  • Changing font include to work on HTTPS.
  • Some refactors and bugfixes.

0.6.0

0.5.2

  • Add css for printing.
  • Bugfix: Template IE8 compatibility. (apidoc#69)

0.5.1

  • 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)

0.5.0

0.4.4

  • Preserve other files when copying template files to the destination output dir.

0.4.3

0.4.2

  • Bugfix: Fix parsing of multiline string. (apidoc#34)

0.4.1

  • Add support for CoffeeScript comment-style.

0.4.0

  • 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.

0.3.0

  • Replace deprecated node-markdown with marked.
  • Add cli parameter for marked --marked-..., watch all params with--help.
  • Upgrade all used node modules.

0.2.8

  • Bugfix: executable line delimiters. (again).

0.2.7

  • Bugfix: Allow usage of structures and titles in the same block. (apidoc#21)

0.2.6

  • Give some indication, in case file listing with fails. (apidoc#20)

0.2.5

  • Allow multiple structure includes.
  • Split and extend test-files.

0.2.4

  • 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)

0.2.3

  • Extend Template with url-param "compare=1" to show the compare version on page view.
  • Bugfix: Minor fix with double structure examples.

0.2.2

  • Bugfix: Template not show @apiSuccessExample @apiErrorExample.

0.2.1

  • Bugfix: executable line delimiters.

0.2.0

0.1.11

  • Allow whitespace in apiName and apiGroup.
  • Bugfix: Filter for directories.
  • Update Node Modules to newer versions.

0.1.10

  • Add -e exclude option for Files / Directories, example apidoc -e node_modules/.

0.1.10

  • Bugfix: Check for a valid title in Template. (apidoc#7)

0.1.9

  • Bugfix: Whitespace before comment block. (apidoc#2)

0.1.8

  • Change templates, enable navigation scroll.

0.1.7

0.1.6

  • Bugfix: OSX executable.

0.1.5

  • Official release.