YUIDoc v0.5.0 Release Notes
Release Date: 2015-01-20 // about 9 years ago-
๐ 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.0Please 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
- ๐ Bug Fixes
- โจ Enhancements
- #310: Update the license file URL
- #306: Use
res.status(status).send(body)
instead ofres.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
toCONTRIBUTING.md
- โก๏ธ Dependencies Updates
Thanks!
๐ We appreciate your helps for this release. Thanks to @caridy, @juandopazo, @newbreedofgeek, @tivac, @Infinitycbs, @artsyca, and @NateEag.