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

Documentation on constructor properties are not included in output #2019

Closed
thopaw opened this issue Jul 28, 2022 · 1 comment
Closed

Documentation on constructor properties are not included in output #2019

thopaw opened this issue Jul 28, 2022 · 1 comment
Labels
bug Functionality does not match expectation

Comments

@thopaw
Copy link

thopaw commented Jul 28, 2022

Search terms

constructor properties

Expected Behavior

Documented parameters within a constructor should also be documented in the output.

Is it possible to also use the doc added to the constructor property?

class A {
  constructor(
    /**
     * I want to see this comment in the documentation
     * /
     readonly property: string) {}
}

Actual Behavior

The generated documentation does include the parameter property but does not include the documentation of the parameter.

I can add a doc to the constructor itself but I can not add the same options as documenting the property directly like

class A {
   /**
     * I want to see this comment in the documentation
     * /
  readonly property: string

}

Steps to reproduce the bug

class A {
  constructor(
    /**
     * I want to see this comment in the documentation
     * /
     readonly property: string) {}
}

Environment

> typedoc --version

TypeDoc 0.23.9
Using TypeScript 4.7.4 from ./node_modules/typescript/lib

> node --version
v16.14.0

  • OS: Ubuntu 20.04
@thopaw thopaw added the bug Functionality does not match expectation label Jul 28, 2022
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jul 30, 2022

Seems reasonable to me 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

2 participants