v0.4.0

Today we released YUIDoc 0.4.0. You can install and try the new version via npm right now.

$ npm install -g yuidocjs

It has some new features, bug fixes, enhancements, and dependencies updates. There're also no breaking changes.

Here is all the changes between 0.3.50 and 0.4.0.
v0.3.50...v0.4.0

Please file an issue on GitHub if you have any problems.
https://github.com/yui/yuidoc/issues/new

New Features

Supports ES6 style rest parameters syntax for multiple parameters

It supports rest parameters syntax same way with ECMAScript 6 (ES6) for multiple parameters as follows.

/**
 * Foo
 *
 * @method foo
 * @param {String} param1 My Parameter 1
 * @param {Array} ...args My Arguments
 */
function foo(param1, ...args) {
    // do something!
}

The legacy syntax is maintained like this.

/**
 * Foo
 *
 * @method foo
 * @param {String} param1 My Parameter 1
 * @param {Array} args* My Arguments
 */
function foo(param1, ...args) {
    // do something!
}

Allows base URLs for external links

It now allows base URLs for external links in your yuidoc.json like this.

  "external": {
    "data": [
      {
        "base": "http://emberjs.com/api/",
        "json": "http://builds.emberjs.com/tags/v1.5.1/ember-docs.json"
      },
      {
        "base": "http://emberjs.com/api/",
        "json": "http://builds.emberjs.com/tags/v1.0.0-beta.6/ember-data-docs.json"
      }
    ]
  }

The external data without base URLs also works.

  "external": {
    "data": [
      "http://builds.emberjs.com/tags/v1.5.1/ember-docs.json"
    ]
  }

Adds --no-sort option

You're able to use the --no-sort option if you don't need alphabetical sorting of attributes, events, methods, and properties.

$ yuidoc --no-sort .

Default is alphabetical sorting as before.

Change Logs

• New Features
  • #158: Supports ES6 rest parameters syntax for multiple parameters (@juandopazo)
  • #253: Allow base URLs for external links (fixes #237, @mmpestorich)
  • #261: Adds --no-sort option (fixes #80, @timdp)
• Bug Fixes
  • #275: Fix a bug with a logo doesn't shows when use preprocessor feature (@limikael)
  • #267: Fix a wrong link in the syntax document (@RD5)
  • #278: Fix fails to parse default parameters value that contains a space (fixes #268)
  • #262: Fix a bug with parsing the optional parameters syntax
  • #269: Fix HTML syntax in the document
• Enhancements
  • #276: Document for external base URLs
  • #282: Test for --no-sort option
  • #281: Add the help for --no-sort option
  • #271: Revamp README
  • #265: Drop Node.js 0.8 from Travis CI
• Dependencies Updates
  • #277: Depend on yui@^3.14.1
  • #274: Depend on express@^4.10.1
  • #272: Depend on minimatch^1.0.0
  • #266: Depend on marked@^0.3.2

Development Members Updates

@okuryu and @andrewnicols have been promoted to collaborators for YUIDoc. Please ping us if you have any feedbacks.

See also #263.

Thanks!

We have many contributors for this release. Thanks to @caridy, @juandopazo, @mmpestorich, @timdp, @limikael, and @RD5.