Skip to content

v0.5.0
Compare
Choose a tag to compare
@okuryu okuryu released this 20 Jan 12:35
· 116 commits to master since this release
v0.5.0
bec3104

YUIDoc v0.5.0 have been released today. You can install and try the new version via npm right now.

$ npm install -g yuidocjs

YUIDoc supports @throws tag finally, and it includes more compatibility with Handlebars v2.0, enhancements, and dependencies updates. There're also no breaking changes.

Here is all the changes between v0.4.0 and v0.5.0.
v0.4.0...v0.5.0

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

New Features

Support @throws tag

It supports @throws tags for your methods as follows.

/**
* @method getName
* @throws {Error} Throws an exception error.
*/
function getName() {
    // do something
}

Notes for custom theme creators

YUIDoc v0.5.0 depends on Handlebars v2. If you're an author of custom theme, you may cause a defect in the indentation processed by this change. If you bumped into this problem, you will need to fix your template in either of the following ways.

1. Remove indents of partials

{{#if methods}}
    <div id="methods">
{{>method}}
    </div>
{{/if}}

2. Use whitespace controlled partials instead

{{#if methods}}
    <div id="methods">
        {{~>method}}
    </div>
{{/if}}

See also:

This information is provided by @NateEag, thanks!

Changelog

  • New Features
    • #305: Support @throws tag (fixes #135)
  • Bug Fixes
    • #309: Fix link to source files at simple theme templates (fixes #186)
    • #308: Fix a bug with parse files written in CR newline (fixes #96)
    • #302: Unindent method Handlebars Helpers (fixes #300)
    • #292: Fix indents of templates and bumps YUI dependencies (fixes #288)
  • Enhancements
    • #310: Update the license file URL
    • #306: Use res.status(status).send(body) instead of res.send(body, status)
    • #297: Update assets resources for high display resolution
    • #295: Tweak @param comments for API docs
    • #293: Improve some conditional in the builder.js
    • #289: Improve tests for CoffeeScript
    • #287: Support comments start with * in CoffeeScript (@artsyca)
    • #286: Fix expressions of JavaScript
    • #285: Remove unneeded comma
    • #284: Remove unused tests
    • #283: Move from DEVELOPMENT.md to CONTRIBUTING.md
  • Dependencies Updates
    • #307: Depend on istanbul@^0.3.5
    • #298: Depend on minimatch@^2.0.1

Thanks!

We appreciate your helps for this release. Thanks to @caridy, @juandopazo, @newbreedofgeek, @tivac, @Infinitycbs, @artsyca, and @NateEag.

Assets 2
Loading