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 are not generated #261

Open
IvanFarkas opened this issue May 21, 2024 · 0 comments
Open

Enum values are not generated #261

IvanFarkas opened this issue May 21, 2024 · 0 comments

Comments

@IvanFarkas
Copy link

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"
  }
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant