All Versions
32
Latest Version
Avg Release Cycle
166 days
Latest Release
591 days ago

Changelog History
Page 2

  • v0.5.2 Changes

    October 05, 2014
    • 👌 Support event tags, add isEvent parameter to comment object
    • ✂ Removed obsolete make rules

  • v0.5.1 Changes

    September 07, 2014
    • Fixed: */* breaks parsing

  • v0.5.0 Changes

    September 04, 2014
    • 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.

  • v0.4.6 Changes

    July 09, 2014
    • do not wrap @example contents with markdown

  • v0.4.5 Changes

    July 09, 2014
    • use marked for markdown rendering
    • multiline tags support (@example)
    • support for @template, @property, @define, @public, @private, @protected, @lends, @extends, @implements, @enum, @typedef

  • v0.4.4 Changes

    July 28, 2013
    • add support for variable names containing "$". fix #102

  • v0.4.3 Changes

    March 18, 2013
    • fix dox(1) --version. Closes #91
    • fix ctx.string on properties of a prototype
    • add support tab-indented comments

  • v0.4.2 Changes

    January 18, 2013
    • Prevent error when using --api & comments have no example code.

  • v0.4.1 Changes

    November 11, 2012
    • change # to . in --api

  • v0.4.0 Changes

    November 09, 2012
    • add TOC to --api. Closes #72
    • add gfm code blocks. Closes #71
    • remove implicit titles. Closes #70