@microsoft/api-documenter
Version:
Read JSON files from api-extractor, generate documentation pages
24 lines • 943 B
TypeScript
import type { ApiModel } from '@microsoft/api-extractor-model';
import type { IYamlTocItem } from '../yaml/IYamlTocFile';
import type { IYamlItem } from '../yaml/IYamlApiFile';
import { YamlDocumenter } from './YamlDocumenter';
/**
* Extends YamlDocumenter with some custom logic that is specific to Office Add-ins.
*/
export declare class OfficeYamlDocumenter extends YamlDocumenter {
private _snippets;
private _snippetsAll;
private _apiSetUrlDefault;
private _apiSetUrls;
constructor(apiModel: ApiModel, inputFolder: string, newDocfxNamespaces?: boolean);
/** @override */
generateFiles(outputFolder: string): void;
/** @override */
protected onGetTocRoot(): IYamlTocItem;
/** @override */
protected onCustomizeYamlItem(yamlItem: IYamlItem): void;
private _fixupApiSet;
private _getApiSetUrl;
private _generateExampleSnippetText;
}
//# sourceMappingURL=OfficeYamlDocumenter.d.ts.map