jsdoc - npm Package Versions

3.6.6 (September 2020)

Fixes an issue that could cause members of an interface to be tracked incorrectly if the interface was both defined as an ES2015 class and assigned to a variable. For example:

/** @interface */
foo.Bar = class {
  constructor() {
    /** This member was missing from the generated docs. */
    this.baz = null;
  }
};

3.6.5 (July 2020)

Prevents circular references in doclets when two function parameters use the same type expression, and the --debug flag is present.

3.6.4 (April 2020)

Updates dependencies.

3.6.3 (July 2019)

Updates dependencies.

3.6.2 (May 2019)

Fixes an issue that prevented ES 2015 classes from appearing in generated docs. ([#1644][1644])

3.6.1 (May 2019)

Prevents a crash when using type applications in Node.js 12. ([#1643][1643])

3.6.0 (May 2019)

Major changes

• JSDoc is now compatible with Node.js 12, and it requires Node.js 8.15.0 or later.
• JSDoc now recognizes all documented Closure Compiler tags. ([#605][605])

Enhancements

• You can now use the templates.useShortNamesInLinks configuration setting to show the short name of each symbol in link text (for example, baz), rather than the full longname (for example, foo.bar.baz). ([#738][738])
• When you enable the Markdown plugin, you can now specify a function that performs syntax highlighting in code blocks. ([#1412][1412])
• The default template now places namespaces near the top of the TOC. ([#1410][1410])

Bug fixes

• When you add a JSDoc comment to an ES2015 constructor, JSDoc now preserves all of the JSDoc tags, not only the description and parameters. ([#1129][1129])
• The @exports tag now works correctly when it is combined with the @enum tag. ([#970][970])
• When you enable the Markdown plugin, and you use a code fence with the language set to plain, JSDoc no longer pretty-prints the code block in the generated documentation. ([#1361][1361])

3.5.5 (September 2017)

Fixes a compatibility issue with Node.js 8.5.0. (#1438)

3.5.4 (August 2017)

• When a class uses the @hideconstructor tag, the default template no longer displays the names of parameters that the constructor accepts. (#1397)
• When an arrow function expression returns a class, the class's methods and properties are now named correctly. (#1409)
• JSDoc no longer crashes when an anonymous class is passed as a function parameter. (#1416)
• JSDoc now allows import and export declarations anywhere where a statement is allowed. (#1411)
• JSDoc now allows return statements outside of functions. (#1411)
• JSDoc now allows super() calls outside of a method definition. (#1411)
• JSDoc no longer exits before the STDOUT pipe has been flushed. (#1408)

3.5.3 (July 2017)

• Non-JSDoc comments (comments that do not begin with /**) are now ignored. (#1398)
• JSDoc no longer crashes when it parses a class property with no value assigned to it. (#1400)
• When there are JSDoc comments at the end of a source file that has a 'use strict'; directive, the comments are no longer ignored. (#1396)
• Namepaths that contain an @ sign (for example, module:@prefix/my-module~myCallback) are now parsed correctly. (#1302)
• The default template now displays interfaces that belong to a namespace. (#1406)
• When an ES2015 class inside a module uses an @alias tag, the class's constructor now gets the correct longname. (#1395)
• When there are no input files to process, JSDoc no longer prints help text to the console. (#1404)