JSPM

esdoc-var-plugin

0.1.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1
  • Score
    100M100P100Q55295F
  • License MIT

ESDoc Plugin to add support for "@var" to document module variables

Package Exports

  • esdoc-var-plugin

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (esdoc-var-plugin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

esdoc-var-plugin

ESDoc Plugin to add support for the @var-tag to document module variables that are not exported.

Usage

Install it:

npm install esdoc-var-plugin

And include it in the plugin property of esdoc.json:

{
  "source": "./src",
  "destination": "./doc",
  "plugins": [
    { "name": "esdoc-var-plugin" }
  ]
}

License: MIT