kist/js/actions/DocumentationAction/DocumentationAction.d.ts

Package Pipeline Processor

import { Action } from "../../core/pipeline/Action";
import { ActionOptionsType } from "../../types/ActionOptionsType";
/**
 * DocumentationAction automates the generation of documentation for software
 * projects. This action allows specifying a documentation generator, source
 * paths, and output locations.
 */
export declare class DocumentationAction extends Action {
    /**
     * Executes the documentation generation process using the specified command-line tool.
     *
     * @param options - The options specifying the generator tool, source path, and output path.
     * @returns A Promise that resolves when documentation generation completes successfully.
     * @throws {Error} Throws an error if the documentation process fails.
     */
    execute(options: ActionOptionsType): Promise<void>;
    /**
     * Provides a description of the action.
     *
     * @returns A string description of the action.
     */
    describe(): string;
}