All Versions
10
Latest Version
Avg Release Cycle
67 days
Latest Release
1926 days ago

Changelog History

  • v0.10.2

    July 11, 2016
  • v0.10.1

    April 25, 2016
  • v0.10.0 Changes

    January 18, 2016

    Summary

    ๐Ÿš€ YUIDoc v0.10.0 is released. There're some improving and fixing. Specifically, thanks a lot to contributions from @mixonic and @stefanpenner.

    ๐Ÿ”„ ChangeLog

    ๐Ÿ›  Fixed

    ๐Ÿ”„ Changed

    • ๐Ÿ‘ท #388: Travis CI testing on Node v4

    โšก๏ธ Dependencies Updated

  • v0.9.0 Changes

    August 19, 2015

    Summary

    ๐Ÿš€ 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 @element tag. It also added new secondary tags @parents, @contents and @interface for @element.

    /\*\* \* @element x-my-component \* @parents \<body\> \* @contents \<x-sub-component\> \* @interface XMyComponent \*/
    

    ๐Ÿ—„ @element also supports generic tags like @example and @deprecated.

    ๐Ÿ”„ ChangeLog

    ๐Ÿ”„ Changed

    • ๐Ÿ›  #371: Support documenting Custom Elements (fixes #328)

    โšก๏ธ Dependencies Updated

  • v0.8.1 Changes

    July 30, 2015

    Summary

    ๐Ÿš€ YUIDoc v0.8.1 have been released today. It's just includes minor changes.

    ๐Ÿ”„ ChangeLog

    ๐Ÿ›  Fixed

    ๐Ÿ”„ Changed

    • โฌ†๏ธ #370: Upgrade to faster, container-based builds on Travis CI (@floydpink)
  • v0.8.0 Changes

    July 24, 2015

    Summary

    ๐Ÿš€ YUIDoc v0.8.0 have been released today. We've been introduced new mdn-links module 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 @implements and @interface tags (fixes #355, @mlzummo)
    • ๐Ÿ“ฆ #353: Use SPDX license Identifier in package.json

    ๐Ÿ”„ Changed

    โšก๏ธ Dependencies Updated

  • v0.7.0 Changes

    April 29, 2015

    Summary

    ๐Ÿš€ YUIDoc v0.7.0 have been released today. We've upgraded markdown-it from 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

    • ๐Ÿ›  #318: Fix a bug with "@" doesn't escapable in example (fixes #179)

    โšก๏ธ 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 @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

    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.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 .
    

    0๏ธโƒฃ Default is alphabetical sorting as before.

    ๐Ÿ”„ Change Logs

    • ๐Ÿ†• New Features
    • ๐Ÿ› 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

    โšก๏ธ 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.