f16ca1ce46
In the code base there are cases where there is, conceptually, a class
that is represented by a combination of an `interface`
(type declaration) and a `const` (value declaration).
For example:
```
export interface SomeClass {
count(a?: string): number;
}
export const: SomeClass = class {
someMethod(a: string = ''): number { ... }
};
```
These were being rendered as interfaces and also not
correctly showing the descriptions and default parameter
values.
In this commit such concepts are now rendered as classes.
The classes that are affected by this are:
* `DebugElement`
* `DebugNode`
* `Type`
* `EventEmitter`
* `TestBed`
Note that while decorators are also defined in this form
they have their own rendering type (`decorator`) and so
are not affecte by this.
PR Close #36989
32 lines
1.0 KiB
JavaScript
32 lines
1.0 KiB
JavaScript
/**
|
|
* @dgProcessor
|
|
*
|
|
* @description
|
|
* Merge the description from `@param` tags into the parameter docs
|
|
* extracted from the TypeScript
|
|
*
|
|
* This is actually an override of the processor provided by the `typescript` dgeni package.
|
|
* The original does not set the `defaultValue`.
|
|
*/
|
|
module.exports = function mergeParameterInfo() {
|
|
return {
|
|
$runAfter: ['readTypeScriptModules', 'tags-extracted'],
|
|
$runBefore: ['extra-docs-added'],
|
|
$process(docs) {
|
|
docs.forEach((doc) => {
|
|
if (doc.docType === 'parameter') {
|
|
// The `params` property comes from parsing the `@param` jsdoc tags on the container doc
|
|
const paramTag =
|
|
doc.container.params && doc.container.params.find(param => param.name === doc.name);
|
|
if (paramTag && paramTag.description) {
|
|
doc.description = paramTag.description;
|
|
if (doc.defaultValue === undefined) {
|
|
doc.defaultValue = paramTag.defaultValue;
|
|
}
|
|
}
|
|
}
|
|
});
|
|
},
|
|
};
|
|
};
|