You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 */exportclassExample{/** * Property that I want to document */property1: numberproperty2: 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.
The text was updated successfully, but these errors were encountered:
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:I want
property1
to show up in Typedoc but notproperty2
.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.The text was updated successfully, but these errors were encountered: