JSDoc v3.0.1 Release Notes

Release Date: 2012-06-01 // almost 12 years ago
  • ✨ Enhancements

    • The conf.json file may now contain source.include and source.exclude properties. (#56)
      • source.include specifies files or directories that JSDoc should always check for documentation.
      • source.exclude specifies files or directories that JSDoc should never check for documentation. These settings take precedence over the source.includePattern and source.excludePattern properties, which contain regular expressions that JSDoc uses to search for source files.
    • The -t/--template option may now specify the absolute path to a template. (#122)

    🐛 Bug fixes

    • JSDoc no longer throws exceptions when a symbol has a special name, such as hasOwnProperty. (1ef37251)
    • The @alias tag now works correctly when documenting inner classes as globals. (810dd7f7)

    Template improvements

    • 0️⃣ The default template now sorts classes by name correctly when the classes come from several modules. (4ce17195)
    • 👍 The Haruki template now correctly supports @example, @members, and @returns tags. (6580e176, 59655252, 31c8554d)