jsdoc-toolkit/changes.txt

   1 == 2.4.0 ==
   2
   3   * Fixed bug that added mutiple symbols with the same name to docs.
   4   * Added support for the -m option to suppress warnings for multiple docs.
   5   * Added patch by brownsea42 to support quoted user variables on the command line. ( issue #281 )
   6   * Fixed bug that sometimes caused links to events to be incorrect. ( issue #292 )
   7
   8 == 2.3.3 ==
   9
  10   * Fixed bug that made all fields declared with the @property tag static. ( issue #262 )
  11   * Minor fix to better handle trailing slash on path to template (from jwmetrocat). ( issue #237 )
  12   * Fix for @memberOf when applied to inner members. ( issue #264 )
  13   * Fix for @memberOf when applied to symbols documented with @name. ( issue #260 )
  14   * Applied patch from kunhualqk, fix for bug where @link to borrowed member did not resolve to parent class. ( issue #218 )
  15   * Fix for @requires not linking back to the required class
  16   * Added experimental support for @constructs to have an argument, the class name, when applied to a function assignment.
  17
  18 == 2.3.2 ==
  19
  20  * Minor update to the usage notes and corrected the version number displayed in the output.
  21
  22 == 2.3.1 ==
  23
  24  * Fixed HTML typo in allfiles template. ( issue #228 )
  25  * Modified template to display version information for classes.
  26  * Modified template to better support multiple methods with the same name.
  27  * Fixed bug that caused template to error when backtick characters appeared around class names.
  28
  29 == 2.3.0 ==
  30
  31   * Added option -u, --unique to avoid bug that causes multiple symbols with names that differ only by case to overwrite each others output on case-insensitive filesystems. ( issue #162 )
  32   * Fixed bug where {@links} in @deprecated tags did not resolve. ( issue #220 )
  33   * Fixed bug that caused parens around a function to make it to be unrecognized. ( issue #213 )
  34   * Fixed bug prevented explicit links to named anchors from working (thanks katgao.pku). ( issue #215 )
  35   * Fixed bug that prevented full description from appearing in file overview. ( issue #224 )
  36
  37 == 2.2.1 ==
  38
  39   * Fixed bug with class template, where sorting of methods was accidentally removed (thanks dezfowler).
  40   * Added missing test files for the @exports unit tests.
  41
  42 == 2.2.0 ==
  43
  44   * Fixed bug that caused exception when given a folder containing non-js files, even with the x commandline option set to "js". ( issue #193 )
  45   * Fixed typo in index template [patch submitted by olle]. ( issue #198 )
  46   * Modified @borrows tag experimentally to allow for missing "as ..." clause.
  47   * Added support for the @exports tag, to allow one symbol to be documented as another.
  48   * Added support for the -S option to document code following the Secure Modules pattern.
  49
  50 == 2.1.0 ==
  51
  52   * Added support for the @event tag.
  53   * Fixed bug that prevented the : character from appearing in symbol names.
  54   * Fixed bug that prevented underscored symbols marked with @public being tagged as private. (issue #184 )
  55   * Fixed bug that randomly affected the @memberOf tag when the name of the symbol did not include the parent name.
  56   * Fixed bug that prevented templates that were not in the jsdoc-toolkit folder from being found. ( issue #176 )
  57   * Added ability to check for trailing slash on template path. ( issue #177 )
  58   * Modified classDesc so that it no longer is appended with the constructor desc.
  59   * Fixed call to plugin onDocCommentSrc.
  60   * Added missing support for inline doc comments for function return types. ( issue #189 )
  61   * Added command line option -q, --quiet.
  62   * Added command line option -E, --exclude. ( issue #143 )
  63   * Added 2 more hooks for plugins. ( issue #163 )
  64   * Added support for extending built-ins. ( issue #160 )
  65   * Added "compact" option to JSDOC.JsPlate.prototype.process. ( issue #159 )
  66   * @augments no longer documents static members as inherited. ( issue #138 )
  67   * @link to a class now goes to the page for that class, not the constructor. ( issue #178 )
  68   * Warnings of mismatched curly brace now include filename. ( issue #166 )
  69   * Fixed bug affecting template paths loaded via a configuration file when the trailing slash is missing. ( issue #191 )
  70   * Minor optimizations.
  71
  72 == 2.0.2 ==
  73
  74   * Fixed bug that sometimes caused an example of division in the source code to be interpretted as a regex by the JsDoc Toolkit analyzer. ( issue #158 )
  75   * Fixed a bug that prevented private variables marked as @public from appearing in the documentation. ( issue #161 )
  76   * Fixed bug that prevented variable names with underscored properties from appearing in summaries. ( issue #173 )
  77
  78 == 2.0.1 ==
  79
  80   * Fixed bug that prevented @fileOverview tag from being recognized.
  81   * Added support for @fieldOf as a synonym for @field plus @memberOf.
  82   * Added support for @name tag in a @fileOverview comment to control the displayed name of the file.
  83   * Added support for multiple @example tags. ( issue #152 )
  84   * Modified style sheet of jsdoc template to make more readable. ( issue #151 )
  85   * Fixed bug that prevented @since documentation from displaying correctly when it appeared in a class. ( issue #150 )
  86   * Fixed bug that caused inhertited properties to sometimes not resolve correctly. ( issue #144 )
  87   * Modified so that trailing whitespace in @example is always trimmed. ( issue #153 )
  88   * Added support for elseif to JsPlate. (hat tip to fredck)
  89   * Added support for @location urls in the @overview comment to the jsdoc template.
  90
  91 == Changes From Versions 1.4.0 to 2.0.0 ==
  92
  93   * Upgraded included version of Rhino from 1.6 to 1.7R1.
  94   * Removed circular references in parsed documentation objects.
  95   * Improved inheritance handling, now properties and events can be inherited same as methods.
  96   * Improved handling of cross-file relationships, now having two related objects in separate files is not a problem.
  97   * Improved ability to recognize membership of previously defined objects.
  98   * Added ability to redefine parsing behavior with plugins.
  99   * @methodOf is a synonym for @function and @memberOf.
 100   * Added @default to document default values of members that are objects.
 101   * Added ability to parse and refer to inner functions.
 102   * Fixed bug that appeared when calling a method to set properties of the instance referred to by "this".
 103   * Added ability to automatically create links to other symbols.
 104   * New "jsdoc" template now produces fully W3C valid XHTML.
 105   * Inline parameter type hint comments are now documented.
 106   * Fixed error: Locally scoped variables (declared with var) no longer appear as global.
 107   * It is now possible to run JsDoc Toolkit from any directory.
 108   * Added support for inline {@link ...} tags.
 109   * Added support for the -H command-line option to allow for custom content handlers.
 110   * Tag names @inherits and @scope changed to @borrows and @lends.
 111   ? Combining @constructor in a doclet with @lends now supported.
 112   * Multiple @lend tags now supported.
 113   * Added support for the @constructs tag, used inside a @lends block.
 114   * Added support for the @constant tag.
 115   * Fixed bug that prevented the use of [] as a default value.
 116   * Added support for the @field tag.
 117   * Added support for the @public tag (applied to inner functions).
 118   * @namespace tag can now be applied to functions, not just object literals.
 119   * Added support for the -s command line option to suppress source code output.
 120   * Added new unit test framework.
 121   * Underscored symbols are now treated as if they have a @private tag by default.
 122   * Improved support for anonymous constructors.
 123   * Added support for the nocode meta tag.
 124