Function processInheritDoc
- processInheritDoc(
options: {
dependencies: GraphAnalysis<DependencyNodes>;
logger: ColorLogger;
},
): voidParameters
- options: { dependencies: GraphAnalysis<DependencyNodes>; logger: ColorLogger }
Options
dependencies: GraphAnalysis<DependencyNodes>
Dependency graph
logger: ColorLogger
Logger instance.
Returns void
- options: { dependencies: GraphAnalysis<DependencyNodes>; logger: ColorLogger }
Implements a postprocessor to support
@inheritDoc. By making a depth first search across the dependencies graph at every depth classes are processed for methods and constructor functions that have the@inheritDocparam. A backward traversal is performed from the current class through parent inheritance to promote the types of the parent class to child.@inheritDocmarked methods must have the same number of parameters as the parent implementation. Warnings and generated and improperly formatted methods are skipped.This is necessary as Typescript /
tscdoes not support the@inheritDocJSDoc tag and will mark the types for all methods using it withany.You may enable
verboselogging to see the graph traversal.