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
I'm new to TypeDoc. I see that the requiredToBeDocumented option is documented here: https://typedoc.org/options/validation/#requiredtobedocumented. However, I do not see documentation for what values this option accepts or what they mean. So far I've determined the possible options by intentionally triggering this error message:
[error] 'X' is an invalid value for 'requiredToBeDocumented'. Must be one of: Project, Module, Namespace, Enum, EnumMember, Variable, Function, Class, Interface, Constructor, Property, Method, CallSignature, IndexSignature, ConstructorSignature, Parameter, TypeLiteral, TypeParameter, Accessor, GetSignature, SetSignature, TypeAlias, Reference
It seems weird to me that I have to provide an invalid value in order to even find out what the valid values are.
Even after discovering these values, I'm unsure what some of them mean. Obviously some are obvious, like Function, but others aren't (to me at least). For example, what is CallSignature? (I'm unsure of others as well, not just that one.)
The text was updated successfully, but these errors were encountered:
The API page unfortunately looks like it's also including all of TypeDoc's shortcuts which are unions of two or more reflection kinds (that enum is made up of increasing powers of two to allow such usage)
You're absolutely right that the docs are lacking here, updating!