« Changelog History


dox v0.5.0 Release Notes

Release Date: 2014-09-04 // over 9 years ago
    • Marked options can be set via dox.setMarkedOptions
    • Comment blocks include line and codeStart to mark the first line of the comment block and the first line of the code context.
    • 👕 Ignores jshint, jslint and eslint directives. This can be overridden or added to via the skipPrefixes option and the --skipPrefixes command line flag, which takes a comma separated list of prefixes.
    • The code field trims extra indentation based on the indentation of the first line of code.
    • Set the isConstructor property when a @constructor tag is present and change ctx.type to constructor.
    • Recognizes the following code contexts:
      • Foo.prototype.bar; (property)
      • Foo.prototype = { (prototype)
      • foo: function () { (method)
      • foo: bar (property)
      • get foo () { (property)
      • set foo () { (property)
    • When a comment is present to identify the definition of an object literal, comments for the object's members will include a ctx.constructor property identifying the parent object.
    • 🛠 Fixed: Multi-line comments with no space following the star are parsed correctly.
      • Example: /*comment*/
    • 🛠 Fixed: A code context of Foo.prototype.bar = null; is parsed correctly.
    • @param tags include an optional attribute
    • @returns is recognized as an alias for @return
    • Support comments without descriptions (ex: /** @name Foo **/)
    • 🛠 Fixed: Crash with the --api flag when no headers are generated.
    • 🛠 Fixed: --api output includes aliases.