UNPKG

1.11 kBTypeScriptView Raw
1import { type ApiModel, type ApiItem } from '@microsoft/api-extractor-model';
2import type { IYamlTocFile } from '../yaml/IYamlTocFile';
3import { YamlDocumenter } from './YamlDocumenter';
4import type { DocumenterConfig } from './DocumenterConfig';
5/**
6 * EXPERIMENTAL - This documenter is a prototype of a new config file driven mode of operation for
7 * API Documenter. It is not ready for general usage yet. Its design may change in the future.
8 */
9export declare class ExperimentalYamlDocumenter extends YamlDocumenter {
10 private _config;
11 private _tocPointerMap;
12 private _catchAllPointer;
13 constructor(apiModel: ApiModel, documenterConfig: DocumenterConfig);
14 /** @override */
15 protected buildYamlTocFile(apiItems: ReadonlyArray<ApiItem>): IYamlTocFile;
16 private _buildTocItems2;
17 private _generateTocPointersMap;
18 /**
19 * Filtering out the api-item by inlineTags or category name presence in the item name.
20 */
21 private _filterItem;
22 private _findInlineTagByName;
23 private _shouldNotIncludeInPointersMap;
24}
25//# sourceMappingURL=ExperimentalYamlDocumenter.d.ts.map
\No newline at end of file