jsdoc - npm Package Versions

3.2.2 (November 2013)

Bug fixes

• Addressed a regression in JSDoc 3.2.1 that could prevent a function declaration from shadowing a declaration with the same name in an outer scope. (#513)
• If a child class overrides a method in a parent class without documenting the overridden method, the method's documentation is now copied from the parent class. (#503)
• You can now use inline HTML tags in Markdown-formatted text. In addition, JSDoc now uses only the marked Markdown parser; the markdown-js parser has been removed. (#510)
• Type expressions can now include a much broader range of repeatable types. In addition, you can now use Closure Compiler's nullable and non-nullable modifiers with repeatable types. For example, the type expression ...!string (a repeatable, non-nullable string) is now parsed correctly. (#502)
• If a function accepts a parameter named prototype, the parameter is no longer renamed during parsing. (#505)
• If the list of input files includes relative paths, the paths are now resolved relative to the user's working directory. (a3d33842)

3.2.1 (October 2013)

Enhancements

• JSDoc's parser now fires a processingComplete event after JSDoc has completed all post-processing of the parse results. This event has a doclets property containing an array of doclets. (#421)
• When JSDoc's parser fires a parseComplete event, the event now includes a doclets property containing an array of doclets. (#431)
• You can now use relative paths in the JSDoc configuration file's source.exclude option. Relative paths will be resolved relative to the current working directory. (#405)
• If a symbol uses the @default tag, and its default value is an object literal, this value is now stored as a string, and the doclet will have a defaultvaluetype property containing the string object. This change enables templates to show the default value with appropriate syntax highlighting. (#419)
• Inline {@link} tags can now contain newlines. (#441)

Bug fixes

• Inherited symbols now indicate that they were inherited from the ancestor that defined the symbol, rather than the direct parent. (#422)
• If the first line of a JavaScript file contains a hashbang (for example, #!/usr/bin/env node), the hashbang is now ignored when the file is parsed. (#499)
• Resolved a crash when a JavaScript file contains a JavaScript 1.8 keyword, such as let. (#477)
• The type expression function[] is now parsed correctly. (#493)
• If a module is tagged incorrectly, the module's output file now has a valid filename. (#440, #458)
• For tags that accept names, such as @module and @param, if a hyphen is used to separate the name and description, the hyphen must appear on the same line as the name. This change prevents a Markdown bullet on the followng line from being interpreted as a separator. (#459)
• When lenient mode is enabled, a @param tag with an invalid type expression no longer causes a crash. (#448)
• The @requires tag can now contain an inline tag in its tag text. (#486)
• The @returns tag can now contain inline tags even if a type is not specified. (#444)
• When lenient mode is enabled, a @returns tag with no value no longer causes a crash. (#451)
• The @type tag now works correctly with type expressions that span multiple lines. (#427)
• If a string contains inline {@link} tags preceded by bracketed link text (for example, [test]{@link Test#test}), HTML links are now generated correctly even if the string contains other bracketed text. (#470)
• On POSIX systems, if you run JSDoc using a symlink to the startup script, JSDoc now works correctly. (#492)

Default template

• Pretty-printed source files are now generated by default. To disable this feature, add the property templates.default.outputSourceFiles: false to your conf.json file. (#454)
• Links to a specific line in a source file now work correctly. (#475)
• Pretty-printed source files are now generated using the encoding specified in the -e/--encoding option. (#496)
• If a @default tag is added to a symbol whose default value is an object, the value is now displayed in the output file. (#419)
• Output files now identify symbols as "abstract" rather than "virtual." (#432)

3.2.0 (May 2013)

Major changes

• JSDoc can now parse any valid Google Closure Compiler type expression. Note: As a result of this change, JSDoc quits if a file contains an invalid type expression. To prevent JSDoc from quitting, run JSDoc with the --lenient (-l) command-line option. (Multiple issues)
• You can now use the new @listens tag to indicate that a symbol listens for an event. (#273)

Enhancements

• The parser now fires a parseBegin event before it starts parsing files, as well as a parseComplete event after all files have been parsed. Plugins can define event handlers for these events, and parseBegin handlers can modify the list of files to parse. (#299)

• Event handlers for jsdocCommentFound events can now modify the JSDoc comment. (#228)

• You can now exclude tags from Markdown processing using the new option markdown.excludeTags in the configuration file. (#337)

• You can now use the marked Markdown parser by setting the configuration property markdown.parser to marked. In addition, if markdown.parser is set to gfm, JSDoc will now use the "marked" parser instead. (#385)

• The @typedef tag no longer requires a name when used with a Closure Compiler-style type definition. For example, the following type definition will automatically get the name Foo.Bar:

  ```javascript
      /** @typedef {string} */
      Foo.Bar;
  ```
  
  (#391)
  

• You can now use an inline {@type} tag in a parameter's description. If this tag is present, JSDoc will assume that the parameter uses the type specified in the inline {@type} tag. For example, the following @param tag would cause myParam's type to be documented as Foo:

  ```
  @param {(boolean|string)} myParam - My special parameter. {@type Foo}
  ```
  
  (#152)
  

• The console.log function now behaves the same way as on Node.js. In addition, the functions console.info, console.error, console.warn, and console.trace have been implemented. (#298)

• You can now use npm to install JSDoc globally by running npm install -g. Note: JSDoc will still run under Mozilla Rhino, not Node.js. (#374)

• The jsVersion configuration property has been removed. (#390)

Bug fixes

• JSDoc now quits if the configuration file cannot be loaded. (#407)
• JSDoc's --explain (-X) option now runs much more quickly, and it outputs valid JSON to the console. (#298)
• JSDoc's --lenient (-l) option now prints warnings on STDERR rather than STDOUT. (#298)
• The parser now assigns the correct scope to object properties whose names include single quotes. (#386)
• The parser now recognizes CommonJS modules that export a single function rather than an object. (#384)
• The inline {@link} tag now works correctly when @link is followed by a tab. (#359)
• On POSIX systems, quoted command-line arguments are no longer split on spaces. (#397)

Plugins

• The new overloadHelper plugin makes it easier to link to overloaded methods. (#179)
• The markdown plugin now converts Markdown links in the @see tag. (#297)

Default template enhancements

• You can now use the configuration property templates.default.staticFiles to copy additional static files to the output directory. (#393)
• All output files now use human-readable filenames. (#339)
• The documentation for events now lists the symbols that listen to that event. (#273)
• Links to source files now allow you to jump to the line where a symbol is defined. (#316)
• The output files now link to individual types within a Closure Compiler type expression. (Multiple issues)
• CommonJS modules that export a single function, rather than an object, are now documented more clearly. (#384)
• Functions that can throw multiple types of errors are now documented more clearly. (#389)
• If a @property tag does not identify the property's name, the template no longer throws an error. (#373)
• The type of each @typedef is now displayed. (#391)
• If a @see tag contains a URL (for example, @see http://example.com or @see <http://example.com>), the tag text is now converted to a link. (#371)
• Repeatable parameters are now identified. (#381)
• The "Classes" header is no longer repeated in the navigation bar. (#361)
• When the only documented symbols in global scope are type definitions, you can now click the "Global" header to view their documentation. (#261)