/** * A docstring describes its parameters with `@param name - text` entries. * An entry starts at a line that begins with `@param `, takes the * non-blank lines after it, and ends at the next `@param` line or at a * blank line, which goes with the entry. The dash after the name is * optional. Fenced Markdown examples stay in their containing entry or * prose; their blank lines and `@param` lines do not start or end entries. * Every reader uses `docSections` to find the same entry boundaries. */ /** One `@param` entry: the parameter's name and the text after it. */ export type ParamDoc = { name: string; text: string; }; /** Every `@param` entry in `description`, in order. */ export declare function paramDocs(description: string): ParamDoc[]; /** `description` without the `@param` entries of `boundParamNames`. */ export declare function stripBoundParams(description: string, boundParamNames: string[]): string; /** `description` with every `@param` entry removed, whatever its name. */ export declare function withoutParamDocs(description: string): string;