Bump version 0.9.0

i-a-m · Nov 28, 2014 · f90d2a0 · f90d2a0
1 parent c2203b6
commit f90d2a0
Show file tree

Hide file tree

Showing 7 changed files with 136 additions and 124 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,25 @@
 # apiDoc Changelog
 
+#### 0.9.0
+
+* CLI
+  * Allow to include an external file which can set the markdown settings. (https://github.com/apidoc/apidoc/pull/166)
+
+* Template
+  * Add custom order in [apidoc.json](https://github.com/apidoc/apidoc/blob/master/test/fixtures/example/apidoc.json)
+    Append apiName or apiGroup in the `order` list:
+    ```
+    "order": [
+      "MyGroupName",
+      "MyParameterName",
+      "MyOtherParameterName"
+    ]
+    ```
+
+  * Speed up rendering of subtemplates (https://github.com/apidoc/apidoc/issues/164)
+  * Bugfix: Special char doesn't show in @apiGroup. (https://github.com/apidoc/apidoc/issues/163)
+
+
 #### 0.8.2
 
 * Bugfix: apiGroupDescription from apiDefine not working. (https://github.com/apidoc/apidoc/issues/156)
@@ -75,260 +95,228 @@
 
 #### 0.7.2
 
-Bugfix: Custom parsers not working. (https://github.com/apidoc/apidoc/issues/113)
+* Bugfix: Custom parsers not working. (https://github.com/apidoc/apidoc/issues/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. (https://github.com/apidoc/apidoc/issues/109)
+* 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. (https://github.com/apidoc/apidoc/issues/109)
 
 
 #### 0.7.0
 
-Add rudimentary support for direct api calls (test requests) from within the doc.
-* New configuration var [sampleUrl](http://apidocjs.com#configuration-settings-sample-url) for `apidoc.json`.
-* [@apiSampleRequest](http://apidocjs.com#param-api-sample-request)
-
-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".
+* Add rudimentary support for direct api calls (test requests) from within the doc.
+  * New configuration var [sampleUrl](http://apidocjs.com#configuration-settings-sample-url) for `apidoc.json`.
+  * [@apiSampleRequest](http://apidocjs.com#param-api-sample-request)
+* 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. (https://github.com/apidoc/apidoc/issues/97)
+* Bugfix: Change RegExp for parameter values to handle all chars. (https://github.com/apidoc/apidoc/issues/97)
 
 
 #### 0.6.4
 
-Bugfix: Reserved parameter names. (https://github.com/apidoc/apidoc/issues/96)
+* Bugfix: Reserved parameter names. (https://github.com/apidoc/apidoc/issues/96)
 
 
 #### 0.6.3
 
-Bugfix: Multiple added url to api path after compared to other version. (https://github.com/apidoc/apidoc/issues/87)
+* Bugfix: Multiple added url to api path after compared to other version. (https://github.com/apidoc/apidoc/issues/87)
 
 
 #### 0.6.2
 
-Bugfix: Docs do not generate without optional @api [title]. (https://github.com/apidoc/apidoc/issues/82)
-
-Bugfix: Escape example output in `apiExample`, `apiErrorExample`, `apiSuccessExample`. (https://github.com/apidoc/apidoc/issues/78)
+* Bugfix: Docs do not generate without optional @api [title]. (https://github.com/apidoc/apidoc/issues/82)
+* Bugfix: Escape example output in `apiExample`, `apiErrorExample`, `apiSuccessExample`. (https://github.com/apidoc/apidoc/issues/78)
 
 
 #### 0.6.1
 
-Changing font include to work on HTTPS.
-
-Some refactors and bugfixes.
+* Changing font include to work on HTTPS.
+* Some refactors and bugfixes.
 
 
 #### 0.6.0
 
-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.
+* 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.
 
 
 #### 0.5.2
 
-Add css for printing.
-
-Bugfix: Template IE8 compatibility. (https://github.com/apidoc/apidoc/issues/69)
+* Add css for printing.
+* Bugfix: Template IE8 compatibility. (https://github.com/apidoc/apidoc/issues/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. (https://github.com/apidoc/apidoc/issues/64)
+* 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. (https://github.com/apidoc/apidoc/issues/64)
 
 
 #### 0.5.0
 
-Add new Functions:
-* [@apiGroupDescription](http://apidocjs.com/#param-api-group-description)
-* [@apiHeader](http://apidocjs.com/#param-api-header)
-* [@apiHeaderTitle](http://apidocjs.com/#param-api-header-title)
-* [@apiDefineHeaderStructure](http://apidocjs.com/#param-api-define-header-structure)
-* [@apiHeaderStructure](http://apidocjs.com/#param-api-header-structure)
-
-Remove package.json path `apidocFilename`.
-
-Change package.json path `apidoc`.
+* Add new Functions:
+  * [@apiGroupDescription](http://apidocjs.com/#param-api-group-description)
+  * [@apiHeader](http://apidocjs.com/#param-api-header)
+  * [@apiHeaderTitle](http://apidocjs.com/#param-api-header-title)
+  * [@apiDefineHeaderStructure](http://apidocjs.com/#param-api-define-header-structure)
+  * [@apiHeaderStructure](http://apidocjs.com/#param-api-header-structure)
 
-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.
+* 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.
 
 
 #### 0.4.4
 
-Preserve other files when copying template files to the destination output dir.
+* Preserve other files when copying template files to the destination output dir.
 
 
 #### 0.4.3
 
-Added a short-circuit check. (https://github.com/apidoc/apidoc/issues/41)
+* Added a short-circuit check. (https://github.com/apidoc/apidoc/issues/41)
 
 
 #### 0.4.2
 
-Bugfix: Fix parsing of multiline string. (https://github.com/apidoc/apidoc/issues/34)
+* Bugfix: Fix parsing of multiline string. (https://github.com/apidoc/apidoc/issues/34)
 
 
 #### 0.4.1
 
-Add support for CoffeeScript comment-style.
+* 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.
+* 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
 
-Upgrade all used node modules.
+* Add some programming language test cases.
+* Remove german code comments.
+* Upgrade all used node modules.
 
 
 #### 0.3.0
 
-Replace deprecated node-markdown with [marked](https://github.com/chjj/marked).
-
-Add cli parameter for marked `--marked-...`, watch all params with`--help`.
-
-Upgrade all used node modules.
+* Replace deprecated node-markdown with [marked](https://github.com/chjj/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).
+* Bugfix: executable line delimiters. (again).
 
 
 #### 0.2.7
 
-Bugfix: Allow usage of structures and titles in the same block. (https://github.com/apidoc/apidoc/issues/21)
+* Bugfix: Allow usage of structures and titles in the same block. (https://github.com/apidoc/apidoc/issues/21)
 
 
 #### 0.2.6
 
-Give some indication, in case file listing with fails. (https://github.com/apidoc/apidoc/pull/20)
+* Give some indication, in case file listing with fails. (https://github.com/apidoc/apidoc/pull/20)
 
 
 #### 0.2.5
 
-Allow multiple structure includes.
-
-Split and extend test-files.
+* 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. (https://github.com/apidoc/apidoc/pull/11)
-
-Remove http:// link to make https compliant. (https://github.com/apidoc/apidoc/pull/10)
+* Bugfix: Fix parsing for empty lines and removing stars on data that spans over multiple lines. (https://github.com/apidoc/apidoc/pull/11)
+* Remove http:// link to make https compliant. (https://github.com/apidoc/apidoc/pull/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.
+* 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.
+* Bugfix: Template not show @apiSuccessExample @apiErrorExample.
 
 
 #### 0.2.1
 
-Bugfix: executable line delimiters.
+* Bugfix: executable line delimiters.
 
 
 #### 0.2.0
 
-Extend `@apiParam`, `@apiSuccess`, `@apiError` with a grouping ability. Example `@apiParam (group) varname`.
+* Extend `@apiParam`, `@apiSuccess`, `@apiError` with a grouping ability. Example `@apiParam (group) varname`.
+  view [@apiParam](http://apidocjs.com/#param-api-param)
 
-view [@apiParam](http://apidocjs.com/#param-api-param)
+* Add new Functions:
+  * [@apiParamTitle](http://apidocjs.com/#param-api-param-title)
+  * [@apiSuccessTitle](http://apidocjs.com/#param-api-success-title)
+  * [@apiErrorTitle](http://apidocjs.com/#param-api-error-title)
 
-Add new Functions:
-* [@apiParamTitle](http://apidocjs.com/#param-api-param-title)
-* [@apiSuccessTitle](http://apidocjs.com/#param-api-success-title)
-* [@apiErrorTitle](http://apidocjs.com/#param-api-error-title)
-
-Minor Template-Bugfixes.
+* Minor Template-Bugfixes.
 
 
 #### 0.1.11
 
-Allow whitespace in apiName and apiGroup.
-
-Bugfix: Filter for directories.
-
-Update Node Modules to newer versions.
+* 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/`.
+* Add `-e` exclude option for Files / Directories, example `apidoc -e node_modules/`.
 
 
 #### 0.1.10
 
-Bugfix: Check for a valid title in Template. (https://github.com/apidoc/apidoc/pull/7)
+* Bugfix: Check for a valid title in Template. (https://github.com/apidoc/apidoc/pull/7)
 
 
 #### 0.1.9
 
-Bugfix: Whitespace before comment block. (https://github.com/apidoc/apidoc/pull/2)
+* Bugfix: Whitespace before comment block. (https://github.com/apidoc/apidoc/pull/2)
 
 
 #### 0.1.8
 
-Change templates, enable navigation scroll.
+* Change templates, enable navigation scroll.
 
 
 #### 0.1.7
 
-Add [@apiIgnore](http://apidocjs.com/#param-api-ignore).
-
-Update grunt Modules.
+* Add [@apiIgnore](http://apidocjs.com/#param-api-ignore).
+* Update grunt Modules.
 
 
 #### 0.1.6
 
-Bugfix: OSX executable.
+* Bugfix: OSX executable.
 
 
 #### 0.1.5
 
-Official release.
+* Official release.
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -2,6 +2,9 @@
 
 Thanks to all people that help to make apiDoc better!
 
+* [Buts Johan](https://github.com/butsjoh)
+  * Allow to include an external file which can set the markdown settings. [#166] (https://github.com/apidoc/apidoc/pull/166))
+
 * [Peter Wong](https://github.com/peterwongpp)
   * Hide the ul for tabs if no content [#142] (https://github.com/apidoc/apidoc/pull/142))
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "apidoc",
-  "version": "0.8.2",
+  "version": "0.9.0",
   "description": "RESTful web API Documentation Generator",
   "author": "Peter Rottmann <[email protected]>",
   "preferGlobal": true,

diff --git a/test/fixtures/api_data.js b/test/fixtures/api_data.js
@@ -1,4 +1,4 @@
-define({ api: [
+define({ "api": [
   {
     "type": "get",
     "url": "/define",