Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@enum values not documented when the enumeration is `export`ed #1657

Open
cedx opened this issue Jun 5, 2019 · 0 comments

Comments

Projects
None yet
1 participant
@cedx
Copy link

commented Jun 5, 2019

Documenting the values of a bare @enum works as expected. But if I export the enumeration, its values are not documented anymore.

Input code

// The values of the following enumeration are documented.

/**
 * Provides the list of tokens supported by the parser.
 * @enum {string}
 */
const Token = {

  /** The coverage data of a branch. */
  branchesFound: 'BRF',

  /** The number of branches found. */
  branchesHit: 'BRH',

  /** The number of branches hit. */
  branchData: 'BRDA'
};

// The values of the following enumeration are NOT documented.

/**
 * Provides the list of tokens supported by the parser.
 * @enum {string}
 */
export const Token = {

  /** The coverage data of a branch. */
  branchesFound: 'BRF',

  /** The number of branches found. */
  branchesHit: 'BRH',

  /** The number of branches hit. */
  branchData: 'BRDA'
};

JSDoc configuration

{
  "opts": {
    "destination": "doc/api",
    "readme": "README.md",
    "recurse": true
  },
  "plugins": ["plugins/markdown"],
  "source": {"include": ["lib"]},
  "sourceType": "module",
  "tags": {
    "allowUnknownTags": false,
    "dictionaries": ["jsdoc"]
  },
  "templates": {
    "default": {"includeDate": false}
  }
}

JSDoc debug output

DEBUG: JSDoc 3.6.2 (Sun, 12 May 2019 16:47:31 GMT)
DEBUG: Environment info: {"env":{"conf":{"plugins":["plugins/markdown"],"recurseDepth":10,"source":{"includePattern":".+\\.js(doc|x)?$","excludePattern":"","include":["lib"]},"sourceType":"module","tags":{"allowUnknownTags":false,"dictionaries":["jsdoc"]},"templates":{"monospaceLinks":false,"cleverLinks":false,"default":{"includeDate":false}},"opts":{"destination":"doc/api","readme":"README.md","recurse":true}},"opts":{"_":[],"configure":"etc/jsdoc.json","debug":true,"destination":"doc/api","readme":"README.md","recurse":true,"encoding":"utf8"}}}
DEBUG: Parsing source files: ["/repo/js/lcov.js/lib/branch.js","/repo/js/lcov.js/lib/function.js","/repo/js/lcov.js/lib/index.js","/repo/js/lcov.js/lib/line.js","/repo/js/lcov.js/lib/record.js","/repo/js/lcov.js/lib/report.js","/repo/js/lcov.js/lib/token.js"]

Expected behavior

The values of an exported @enum should appear in the final output.

Current behavior

The values of the exported @enum don't appear in the final output.

Your environment

Software Version
JSDoc 3.6.2
Node.js 12.4.0
npm 6.9.0
Operating system Windows 10 and Ubuntu 19.04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.