/** * Utilities for parsing TSDoc comments and extracting metadata. * * @remarks * This module provides functions for extracting deprecation status, * default values, and other metadata from TSDoc comments. * * @alpha */ import type { SymbolMetadata } from './types'; /** * Metadata extracted from a TSDoc comment. * * @alpha */ interface TSDocMetadata { /** Whether the symbol has an @deprecated tag */ isDeprecated: boolean; /** The deprecation message if provided */ deprecationMessage?: string; /** The default value from \@default or \@defaultValue tag */ defaultValue?: string; /** The enum type from `@enumType` tag ('open' or 'closed') */ enumType?: 'open' | 'closed'; } /** * Extracts metadata from a TSDoc comment string. * * @param commentText - The full comment text including delimiters (e.g., "/** ... *\/") * @returns The extracted metadata * * @alpha */ export declare function extractTSDocMetadata(commentText: string): TSDocMetadata; /** * Converts TSDoc metadata to SymbolMetadata format. * * @param tsdocMetadata - The TSDoc metadata * @returns Symbol metadata for use in ExportedSymbol * * @alpha */ export declare function toSymbolMetadata(tsdocMetadata: TSDocMetadata): SymbolMetadata | undefined; /** * Checks if a comment string is a TSDoc comment (starts with /**). * * @param commentText - The comment text to check * @returns True if this is a TSDoc-style comment * * @alpha */ export declare function isTSDocComment(commentText: string): boolean; export {}; //# sourceMappingURL=tsdoc-utils.d.ts.map