All Versions
100
Latest Version
Avg Release Cycle
49 days
Latest Release
1109 days ago

Changelog History
Page 9

  • v4.0.0-beta15 Changes

    November 23, 2016

    🛠 Fixes

    • Infer class augments tag in cases like Foo extends React.Component

    🔋 Features

  • v4.0.0-beta14 Changes

    • 🛠 Highlight all Markdown, not just examples. Fixes #610
    • 🛠 Fix for --config only strip comments on json files (#611)
    • 🔀 Merge inferred return type like we do for params. Refs #359 (#604)
    • 👌 Support webpack's System.import with nice handy babel plugin (#603)
    • Format optional types with ? instead of
    • 🛠 Fix membership assignment for old-fashioned prototype members (#599)
    • 📚 Update Node API documentation to include only exposed API surface
    • ➕ Add too-much-inference troubleshooting topic

  • v4.0.0-beta13 Changes

    • 🛠 Fix linker null reference error

  • v4.0.0-beta12 Changes

    • ⚡️ Update Doctrine to handle more JSDoc types
    • 🛠 Fix ReferenceError in default theme
    • 0️⃣ Show GitHub link for nested elements in default theme
    • 🛠 Fix linking resolution order

  • v4.0.0-beta11 Changes

  • v4.0.0-beta10 Changes

    • Lower memory consumption when dealing with large codebases
    • 👍 Better support for detecting names and kinds of ES6-exported values
    • 🆕 New document-exported flag allows you to automatically document ES6-exported values, without even a comment! 490

  • v4.0.0-beta1 Changes

    Now using Babel 6!

    📚 Much long-awaited upgrade makes documentation.js compatible with fresh 🆕 new Babel-using codebases.

    And also:

    • 👍 GitHub Enterprise support
    • 🆕 New tag support: abstract, override, readonly, interface, variation, see, todo (only in parsing phase, not yet in all outputs)
    • 0️⃣ Parses jsx and es6 extensions by default, as well as .js
    • 🛠 Fixes polyglot mode
    • Now shows the @throws tag content in Markdown output
    • 👌 Support for example captions

  • v4.0.0-beta Changes

    📚 Revitalized documentation.js command line interface!

    📚 The documentation utility now takes commands:

    • 📚 documentation build extracts and formats documentation
    • 📚 documentation serve provides an auto-reloading server (#236)
    • 📚 documentation lint reviews files for inconsistencies
    • 📚 documentation readme patches API documentation into a readme (#313 by @anandthakker)

    📚 This functionality was previously included in dev-documentation and has 📚 been folded into documentation proper.

    Much more flexible themes

    📚 Themes are now much more customizable. In documentation.js 3.x and before, themes were required to use Handlebars templates and produce a single page. In 📚 documentation.js 4.x and beyond, they are JavaScript modules that can use 👀 any template engine and produce any number of files. See the 📚 new theme documentation for details.

    More precise traversal

    Inference in 4.x is stricter than in 3.x: comments must be adjacent 📚 to the statements they document. This should make documentation generation much more predictable.

    👌 Support for the revealing module pattern

    /** Foo */
function Foo() {
  /** Test */
  function bar() {}
  return {
    bar: bar
  };
}

    🆕 New support for the JavaScript module pattern! 📚 This was implemented in #324 by Charlie Brown.

    💥 Breaking changes

  • v3.0.4 Changes

    • 👍 Allow parameter types to be mixed into explicit parameter documentation. (#239 and #232)
    • 👌 Support GitHub links in Markdown output (#238)

  • v3.0.3 Changes

    • 🛠 Infer typedefs from Flow type aliases. Fixes #227
    • 🛠 Fix type-annotated rest expressions, raised in #230