Changelog History
-
v0.10.2
July 11, 2016 -
v0.10.1
April 25, 2016 -
v0.10.0 Changes
January 18, 2016Summary
🚀 YUIDoc v0.10.0 is released. There're some improving and fixing. Specifically, thanks a lot to contributions from @mixonic and @stefanpenner.
🔄 ChangeLog
🛠 Fixed
- #372: Do not descend ignored directories (@mixonic)
- #395: Loosen node-back first-arg check to match node conventions (@stefanpenner)
🔄 Changed
- 👷 #388: Travis CI testing on Node v4
⚡️ Dependencies Updated
-
v0.9.0 Changes
August 19, 2015Summary
🚀 YUIDoc v0.9.0 have been released today. It includes documenting Custom Element supported. Thanks to great contributions by @andyearnshaw.
🔋 Features
👍 YUIDoc v0.9.0 supports documenting Custom Elements. It provides a new primary
@elementtag. It also added new secondary tags@parents,@contentsand@interfacefor@element./\*\* \* @element x-my-component \* @parents \<body\> \* @contents \<x-sub-component\> \* @interface XMyComponent \*/🗄
@elementalso supports generic tags like@exampleand@deprecated.🔄 ChangeLog
🔄 Changed
⚡️ Dependencies Updated
-
v0.8.1 Changes
July 30, 2015Summary
🚀 YUIDoc v0.8.1 have been released today. It's just includes minor changes.
🔄 ChangeLog
🛠 Fixed
- #369: Unindent examples on properties (@floydpink)
🔄 Changed
- ⬆️ #370: Upgrade to faster, container-based builds on Travis CI (@floydpink)
-
v0.8.0 Changes
July 24, 2015Summary
🚀 YUIDoc v0.8.0 have been released today. We've been introduced new
mdn-linksmodule to improve links to MDN, and we've been moved linting tools from JSHint to ESLint.🔄 ChangeLog
🛠 Fixed
- 🛠 #366: Add docs about using preprocessor option (fixes #360)
- 🛠 #357: Adds
@implementsand@interfacetags (fixes #355, @mlzummo) - 📦 #353: Use SPDX license Identifier in package.json
🔄 Changed
- 🛠 #363: Import utility script for MDN links (fixes #354, @andyearnshaw)
- 👕 #348: Change the linting
⚡️ Dependencies Updated
-
v0.7.0 Changes
April 29, 2015Summary
🚀 YUIDoc v0.7.0 have been released today. We've upgraded
markdown-itfrom v3 to v4, and there are some bug fixes and dependencies updates. It also includes fixes for more compatibility with Node v0.12.🔄 Change Log
🛠 Fixed
- 0️⃣ #346: Switch to true Markdown options as default (fixes #344)
- 📜 #341: Fix a bug that inherited class was parsed twice (fixes #324)
- 🛠 #339: Unindent method Handlebars partials within constructor classes (fixes #323)
- 🔧 #334: Use logFn configuration to logging (fixes #325)
🔄 Changed
- 🚚 #345: Drop removed JSHint rules
⚡️ Dependencies Updates
-
v0.6.0 Changes
March 06, 2015🚀 YUIDoc v0.6.0 have been released. You can install and try the new version via npm right now. Please feel free to file an issue on GitHub if you have any problems.
🔄 Change Log
🔄 Changed
- 📜 #321: Change the Markdown parser to markdown-it
- 👷 #317: Add Node.js v0.12 and io.js in Travis CI setting
🛠 Fixed
⚡️ Dependency Updates
-
v0.5.0 Changes
January 20, 2015🚀 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
@throwstag 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
@throwstag👍 It supports
@throwstags 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
@paramcomments 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.mdtoCONTRIBUTING.md
- ⚡️ Dependencies Updates
Thanks!
🚀 We appreciate your helps for this release. Thanks to @caridy, @juandopazo, @newbreedofgeek, @tivac, @Infinitycbs, @artsyca, and @NateEag.
-
v0.4.0 Changes
November 18, 2014🚀 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.0Please 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.jsonlike 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-sortoptionYou're able to use the
--no-sortoption if you don't need alphabetical sorting of attributes, events, methods, and properties.$ yuidoc --no-sort .0️⃣ 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-sortoption (fixes #80, @timdp)
- 🐛 Bug Fixes
- #275: Fix a bug with a logo doesn't shows when use
preprocessorfeature (@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
- #275: Fix a bug with a logo doesn't shows when use
- ✨ Enhancements
- ⚡️ Dependencies Updates
⚡️ 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.
- 🆕 New Features