better-docs icon indicating copy to clipboard operation
better-docs copied to clipboard

Enum values are not generated

Open IvanFarkas opened this issue 1 year ago • 0 comments

Enum values are not generated

I have the following enum in enums.ts Only the enum type name is getting generated , but not the values. How can I have the enum values (Value1, Value2) showing in the generated document, please?

/**
* Test description
 *
 * @category Enum
 * @public
 * @enum {string}
 */
export enum Test {
  /** Value1 */
  Value1 = 'value 1',

  /** Value2 */
  Value2 = 'value 2',
}

Generated

image

jsdoc.json

{
  "tags": {
    "allowUnknownTags": [ "component", "category", "optional" ],
    "dictionaries": [ "jsdoc", "closure" ]
  },
  "source": {
    "include": [ "src" ],
    "includePattern": "\\.(js|jsx|ts|tsx)$",
    "excludePattern": "(^|\\/|\\\\)_"
  },
  "plugins": [
    "plugins/markdown",
    "node_modules/better-docs/typescript",
    "node_modules/better-docs/component",
    "node_modules/better-docs/category"
  ],
  "templates": {
    "better-docs": {
      "name": "test app,"
    }
  },
  "opts": {
    "readme": "README.md",
    "destination": "docs",
    "recurse": true,
    "template": "node_modules/better-docs"
  }
}

IvanFarkas avatar May 21 '24 06:05 IvanFarkas