@comet-cli/plugin-documentation/dist/plugin-documentation/src/index.d.ts

Plugin for generating API documentation

import { ApiModel, DocumentationPluginConfig, LoggerInterface, PluginInterface } from '@comet-cli/types';
export default class DocumentationPlugin implements PluginInterface {
    execute(model: ApiModel, config: DocumentationPluginConfig, logger: LoggerInterface): Promise<any>;
    name(): string;
    protected compile(config: any[]): Promise<unknown>;
    protected getTitle(config: DocumentationPluginConfig, model: ApiModel): string;
    protected getStyleTag(config: DocumentationPluginConfig): string;
    protected getJsTag(config: DocumentationPluginConfig): string;
    protected getTemplate(config: DocumentationPluginConfig): Promise<string>;
    protected generateMetadata(config: DocumentationPluginConfig): string | undefined;
    protected bundleAssets(config: DocumentationPluginConfig): Promise<{
        css: string;
        js: string;
    }>;
}