Skip to content

Some classes treated as constructor #80

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

Open
mt0erfztxt opened this issue Jun 2, 2019 · 3 comments
Open

Some classes treated as constructor #80

mt0erfztxt opened this issue Jun 2, 2019 · 3 comments
Labels
bug Fixed or implemented. To be released.

Comments

@mt0erfztxt
Copy link

Some classes treated as constructor and displayed accordingly. This causes links to such classes to be broken. How can I made them to be shown as class?

Classes shown in UI as class: src/docs.
Classes shown in UI as constructor: src/docs, src/docs, src/docs.

I played with jsdoc section of docma.json but it doesn't help. Then tried to generate docs with JSDoc using this config

{
  "tags": {
    "allowUnknownTags": false
  },
  "source": {
    "include": [
      "src",
      "README.md"
    ],
    "includePattern": ".js$",
    "excludePattern": "(node_modules/|docs)"
  },
  "plugins": [
    "plugins/markdown"
  ],
  "opts": {
    "template": "node_modules/docdash",
    "encoding": "utf8",
    "destination": "docs/",
    "recurse": true,
    "verbose": true
  },
  "templates": {
    "cleverLinks": false,
    "monospaceLinks": false
  },
  "docdash": {
    "search": true,
    "collapse": true,
    "typedefs": true
  }
}

and all classes displayed as expected.

@OmgImAlexis
Copy link

@onury any chance you could look into this? I've noticed the same issue.

@onury onury added bug Fixed or implemented. To be released. labels Jan 22, 2020
@wvffle
Copy link

wvffle commented Feb 6, 2020

Same thing there. It looks like my classes without constructor show up like class but the ones with defined constructor show up as constructors

@wvffle
Copy link

wvffle commented Feb 6, 2020

After some testing in config it turns out that jsdoc.undocumented set to true fixes this problem

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fixed or implemented. To be released.
Projects
None yet
Development

No branches or pull requests

4 participants