1 | import { Collector } from '../collector/Collector';
|
2 | export declare class ApiReportGenerator {
|
3 | private static _trimSpacesRegExp;
|
4 | /**
|
5 | * Compares the contents of two API files that were created using ApiFileGenerator,
|
6 | * and returns true if they are equivalent. Note that these files are not normally edited
|
7 | * by a human; the "equivalence" comparison here is intended to ignore spurious changes that
|
8 | * might be introduced by a tool, e.g. Git newline normalization or an editor that strips
|
9 | * whitespace when saving.
|
10 | */
|
11 | static areEquivalentApiFileContents(actualFileContent: string, expectedFileContent: string): boolean;
|
12 | static generateReviewFileContent(collector: Collector): string;
|
13 | /**
|
14 | * Before writing out a declaration, _modifySpan() applies various fixups to make it nice.
|
15 | */
|
16 | private static _modifySpan;
|
17 | /**
|
18 | * For declarations marked as `@preapproved`, this is used instead of _modifySpan().
|
19 | */
|
20 | private static _modifySpanForPreapproved;
|
21 | /**
|
22 | * Writes a synopsis of the AEDoc comments, which indicates the release tag,
|
23 | * whether the item has been documented, and any warnings that were detected
|
24 | * by the analysis.
|
25 | */
|
26 | private static _getAedocSynopsis;
|
27 | private static _writeLineAsComments;
|
28 | }
|
29 | //# sourceMappingURL=ApiReportGenerator.d.ts.map |
\ | No newline at end of file |