import { Processor, DocCollection } from 'dgeni'; import { ClassLikeExportDoc } from 'dgeni-packages/typescript/api-doc-types/ClassLikeExportDoc'; import ts from 'typescript'; /** * Factory function for the "Categorizer" processor. Dgeni does not support * dependency injection for classes. The symbol docs map is provided by the * TypeScript dgeni package. */ export declare function categorizer(exportSymbolsToDocsMap: Map): Categorizer; /** * Processor to add properties to docs objects. * * isMethod | Whether the doc is for a method on a class. * isDirective | Whether the doc is for a @Component or a @Directive * isService | Whether the doc is for an @Injectable * isNgModule | Whether the doc is for an NgModule */ export declare class Categorizer implements Processor { /** Shared map that can be used to resolve docs through symbols. */ private _exportSymbolsToDocsMap; $runBefore: string[]; docsPublic: string; docsPrivate: string; breakingChange: string; constructor( /** Shared map that can be used to resolve docs through symbols. */ _exportSymbolsToDocsMap: Map); $process(docs: DocCollection): void; /** * Decorates all class and interface docs inside of the dgeni pipeline. * - Members of a class and interface document will be extracted into separate variables. */ private _decorateClassLikeDoc; /** * Decorates all Dgeni class documents for a simpler use inside of the template. * - Identifies directives, services, NgModules or harnesses and marks them them * inside of the doc. * - Links the Dgeni document to the Dgeni document that the current class extends from. */ private _decorateClassDoc; /** * Method that will be called for each method doc. The parameters for the method-docs * will be normalized, so that they can be easily used inside of dgeni templates. */ private _decorateMethodDoc; /** * Method that will be called for each function export doc. The parameters for the functions * will be normalized, so that they can be easily used inside of Dgeni templates. */ private _decorateFunctionExportDoc; /** * Method that will be called for each const export document. We decorate the const * documents with a property that states whether the constant is deprecated or not. */ private _decorateConstExportDoc; /** * Method that will be called for each type-alias export document. We decorate the type-alias * documents with a property that states whether the type-alias is deprecated or not. */ private _decorateTypeAliasExportDoc; /** * Method that will be called for each property doc. Properties that are Angular inputs or * outputs will be marked. Aliases for the inputs or outputs will be stored as well. */ private _decoratePropertyDoc; /** * Walks through every method of the specified class doc and replaces the method * with its referenced overload method definitions, if the method is having overload definitions. */ private _replaceMethodsWithOverload; /** * Whether the given class doc is considered a test harness. We naively detect * test harness classes by checking the inheritance chain for "ComponentHarness". */ private _isTestHarness; }