changes.txt 8.0 KB

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