Releases · yui/yuidoc

18 Jan 13:31

okuryu

v0.10.0

5b21307

v0.10.0 Latest

Latest

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

#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

Assets 2

19 Aug 15:07

okuryu

v0.9.0

f7f117a

v0.9.0

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

#373: [email protected]

Assets 2

30 Jul 12:17

okuryu

v0.8.1

dc5c56a

v0.8.1

Summary

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)

Assets 2

24 Jul 13:07

okuryu

v0.8.0

c10c5a7

v0.8.0

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

#363: Import utility script for MDN links (fixes #354, @andyearnshaw)
#348: Change the linting

Dependencies Updated

Assets 2

29 Apr 12:48

okuryu

v0.7.0

00f2976

v0.7.0

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

#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

Assets 2

06 Mar 13:20

okuryu

v0.6.0

5c0ae88

v0.6.0

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

Assets 2

20 Jan 12:35

okuryu

v0.5.0

bec3104

v0.5.0

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

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

18 Nov 13:51

okuryu

v0.4.0

0de8440

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.

Thanks!

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

Assets 2

22 Apr 01:47

caridy

v0.3.50

729888e

minor release

PR #222: adding support for preprocessor config

This adds support for custom pre-processors, e.g.: yuidoc.json:

{
    "options": {
        "preprocessor": ["./path/to/custom_doc_preprocessor.js", "yuidoc-preprocessor-foo"]
    }
}

in the example above, you can create an app specific preprocessor, plus a npm package that implements a preprocessor.

PR #227: Allow `@param` and `@return` descriptions to be preceded by a newline.

This fixes the possibility of having more readable comment format:

/**
Main description.

@method foo

@param {String} bar
    This is the bar param.

@param {String} baz
    This is the baz param.

@return {Boolean}
    Whether or not bar and baz got fooed.
**/

Acknowledgements

Special thanks to @limikael and @rgrove for their contributions to this release.

Assets 2

08 Mar 23:55

caridy

v0.3.49

bfb1e52

bugfixes

Intended fix for Issue #216 - Changed url creation to simply join strings. PR #217

Thanks to @iexus for the contribution on this release.

Assets 2

Releases: yui/yuidoc

v0.10.0

Summary

ChangeLog

Fixed

Changed

Dependencies Updated

v0.9.0

Summary

Features

ChangeLog

Changed

Dependencies Updated

v0.8.1

Summary

ChangeLog

Fixed

Changed

v0.8.0

Summary

ChangeLog

Fixed

Changed

Dependencies Updated

v0.7.0

Summary

Change Log

Fixed

Changed

Dependencies Updates

v0.6.0

Change Log

Changed

Fixed

Dependency Updates

v0.5.0

New Features

Support @throws tag

Notes for custom theme creators

1. Remove indents of partials

2. Use whitespace controlled partials instead

Changelog

Thanks!

v0.4.0

New Features

Supports ES6 style rest parameters syntax for multiple parameters

Allows base URLs for external links

Adds --no-sort option

Change Logs

Development Members Updates

Thanks!

minor release

PR #222: adding support for preprocessor config

PR #227: Allow @param and @return descriptions to be preceded by a newline.

Acknowledgements

bugfixes

Support `@throws` tag

Adds `--no-sort` option

PR #227: Allow `@param` and `@return` descriptions to be preceded by a newline.