better-docs
better-docs copied to clipboard
Documentation does not show implemented, extended classes or inherited methods
Version 2.3.2
If an interface extends some parent interface then any inherited members do not show up. Users don't even have a way of knowing that extension is even taking place as the parent class is not listed either.
Example:
interface ObjectValidator<S>
{
/**
* Checks if a number is positive.
* @return this
* @throws {RangeError} if the number is not null
*/
isNull(): S;
}
interface NumberValidator<S> extends ObjectValidator<NumberValidator>
{
/**
* Checks if a number is positive.
* @return this
* @throws {RangeError} if the number is not positive
*/
isPositive(): S;
}
In the above example, NumberValidator should show two methods: isNull()
and isPositive()
.
This functionality is quite critical for my library as I only export the bottom-most interfaces to users. The documentation for these interfaces looks completely empty, even though the ancestors have tons of methods.