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

excludeNotDocumented flag should work also on class properties/methods #1435

Closed
marcofugaro opened this issue Dec 29, 2020 · 1 comment
Closed
Labels
enhancement Improved functionality

Comments

@marcofugaro
Copy link

marcofugaro commented Dec 29, 2020

Search Terms

excludeNotDocumented class properties methods

Problem

Currently, the excludeNotDocumented flags works only for source files. However it would be ideal if it would work also on class methods or properties. For example:

/**
 * Example class
 */
export class Example {

  /**
   * Property that I want to document
   */
  property1: number

  property2: number 

}

I want property1 to show up in Typedoc but not property2.

Usecase: property2 needs to be public because I need to modify that property from within the library, but I don't want for that property to show up in the documentation.

Suggested Solution

Make the flag excludeNotDocumented work for class properties/methods or expose a new flag.

@marcofugaro marcofugaro added the enhancement Improved functionality label Dec 29, 2020
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Dec 30, 2020

That's a bug - fixed in 0.20.4 now :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality
Projects
None yet
Development

No branches or pull requests

2 participants