PageRenderTime 15ms CodeModel.GetById 10ms app.highlight 1ms RepoModel.GetById 2ms app.codeStats 0ms

/trunk/jsdoc-toolkit/changes.txt

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