Socket
Socket
Sign inDemoInstall

documentation

Package Overview
Dependencies
Maintainers
5
Versions
119
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

documentation - npm Package Versions

1
1012

2.1.0-alpha2

Diff

tmcw
published 2.1.0-alpha1 •

tmcw
published 2.1.0-alpha •

tmcw
published 2.0.1 •

Changelog

Source

2.0.1

  • Fixes @param tags that refer to properties of unmentioned objects: these will warn instead of crashing. For instance, /** @param {boolean} foo.bar */.
  • Expose --shallow option in CLI
tmcw
published 2.0.0 •

Changelog

Source

2.0.0

  • Breaking: Removes docset support from documentation.js: this will be supported by a 3rd party tool in the future. This removal means that we no longer have node-sqlite3 as a dependency, and documentation can be installed on systems without a compile toolchain.
  • JSDoc parse errors are now printed to stderr.
  • Parameter tags that document sub-parameters, such as @param {Type} options.option, are now nested under their parent parameter.
  • HTML output now includes events.
  • Error messages now include source file name and line number.
  • @typedef names are now inferred correctly.
tmcw
published 1.4.0 •

Changelog

Source

1.4.0

  • Output for the @throws tag.
  • Output in HTML for the @properties tag.
tmcw
published 1.3.2 •

tmcw
published 1.3.1 •

tmcw
published 1.3.0 •

Changelog

Source

1.3.0

  • Now infers name from class and event tags
  • Support for documenting C++ code with the polyglot option and --polyglot CLI option
  • Fixed github linking
  • Support for JSDoc3-style bracketed optional parameters, like
/**
 * @param {Type} [param=defaultValue]
 */
tmcw
published 1.2.0 •

Changelog

Source

1.2.0

  • Transforms in package.json browserify.transform fields are now applied to source code so that babel, etc can be supported.
  • Fixes crash caused by requiring JSON files
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc