Scoring on all exported symbols is overly punishing #975
Description
Consider the following module
export interface FooOptions {
/**
* Foo ...
*/
foo: string
/**
* Bar ...
*/
bar: string
}
/**
* Foo Class Docs ...
*/
export class Foo {
constructor(options: FooOptions) {
// ...
}
// ...
}Despite the class itself and every option being well documented and intellisense kicking in for new Foo({ ... }) this only yields 50% of documented exported symbols.
I would like to suggest that interfaces and type aliases be not considered in the scoring when it comes to exported symbols, or at the very least, have a much lower weight.
The alternative is that authors need to add rather pointless documentation such as
/**
* Options for the {@link Foo} constructor
*/
export interface FooOptions {
// ...
}