« Changelog History


documentation.js v4.0.0-rc.0 Release Notes

Release Date: 2017-04-21 // almost 7 years ago

  • 🐛 Bug Fixes

    • html output: Fix github links in HTML output (#745) (9554b2f), closes #738
    • params: added code path for type RestElement (6961ee8)

    🔨 Code Refactoring

    💥 BREAKING CHANGES

    • nest: referencing inferred destructure params without renaming them, like $0.x, from JSDoc comments will no longer work. To reference them, instead add a param tag to name the destructuring param, and then refer to members of that name.

    Before:

    /**
 * @param {number} $0.x a member of x
 */
function a({ x }) {}

    After:

    /**
 * @param {Object} options
 * @param {number} options.x a member of x
 */
function a({ x }) {}

    • ➕ Address review comments

    • ⬇️ Reduce testing node requirement back down to 4

    • Don't output empty properties, reduce diff noise

    • Rearrange and document params

    • ⚡️ Simplify param inference, update test fixtures. This is focused around Array destructuring: documenting destructured array elements with indices instead of names, because the names are purely internal details

    • 👉 Use temporary fork to get through blocker