1 |
|
2 |
|
3 |
|
4 |
|
5 |
|
6 |
|
7 |
|
8 |
|
9 |
|
10 |
|
11 |
|
12 |
|
13 |
|
14 | import { NodePath } from '@babel/traverse';
|
15 | import * as babel from '@babel/types';
|
16 | import * as doctrine from 'doctrine';
|
17 | import { Annotation, Tag } from 'doctrine';
|
18 | import { Demo } from '../index';
|
19 | import { Privacy } from '../model/model';
|
20 | import { ScannedReference, Warning } from '../model/model';
|
21 | import { JavaScriptDocument } from './javascript-document';
|
22 | export { Annotation, Tag } from 'doctrine';
|
23 |
|
24 |
|
25 |
|
26 |
|
27 | export declare function parseJsdoc(docs: string): doctrine.Annotation;
|
28 |
|
29 |
|
30 |
|
31 | export declare function removeLeadingAsterisks(description: string): string;
|
32 | export declare function hasTag(jsdoc: Annotation | undefined, title: string): boolean;
|
33 |
|
34 |
|
35 |
|
36 | export declare function getTag(jsdoc: Annotation | undefined, title: string): Tag | undefined;
|
37 | export declare function unindent(text: string): string;
|
38 | export declare function isAnnotationEmpty(docs: Annotation | undefined): boolean;
|
39 | export declare function getPrivacy(jsdoc: Annotation | undefined): Privacy | undefined;
|
40 |
|
41 |
|
42 |
|
43 |
|
44 |
|
45 |
|
46 |
|
47 | export declare function getMixinApplications(document: JavaScriptDocument, node: babel.Node, docs: Annotation, warnings: Warning[], path: NodePath): Array<ScannedReference<'element-mixin'>>;
|
48 | export declare function extractDemos(jsdoc: Annotation | undefined): Demo[];
|
49 | export declare function join(...jsdocs: Array<Annotation | undefined>): Annotation;
|
50 |
|
51 |
|
52 |
|
53 |
|
54 |
|
55 |
|
56 | export declare function pickBestDescription(...descriptions: Array<string | undefined>): string;
|
57 |
|
58 |
|
59 |
|
60 |
|
61 | export declare function getDescription(jsdocAnn: Annotation): string | undefined;
|