| 1 | export interface ExtractedJsDocParam {
|
| 2 | name: string;
|
| 3 | type?: any;
|
| 4 | description?: string;
|
| 5 | getPrettyName: () => string;
|
| 6 | getTypeName: () => string;
|
| 7 | }
|
| 8 | export interface ExtractedJsDocReturns {
|
| 9 | type?: any;
|
| 10 | description?: string;
|
| 11 | getTypeName: () => string;
|
| 12 | }
|
| 13 | export interface ExtractedJsDoc {
|
| 14 | params?: ExtractedJsDocParam[];
|
| 15 | returns?: ExtractedJsDocReturns;
|
| 16 | ignore: boolean;
|
| 17 | }
|
| 18 | export interface JsDocParsingOptions {
|
| 19 | tags?: string[];
|
| 20 | }
|
| 21 | export interface JsDocParsingResult {
|
| 22 | includesJsDoc: boolean;
|
| 23 | ignore: boolean;
|
| 24 | description?: string;
|
| 25 | extractedTags?: ExtractedJsDoc;
|
| 26 | }
|
| 27 | export declare type ParseJsDoc = (value?: string, options?: JsDocParsingOptions) => JsDocParsingResult;
|
| 28 | export declare const parseJsDoc: ParseJsDoc;
|