/** * @license * Copyright 2020 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { DocNode, StringBuilder, DocLinkTag } from '@microsoft/tsdoc'; import { IndentedWriter } from '../utils/IndentedWriter'; export interface IMarkdownEmitterOptions { } export interface IMarkdownEmitterContext { writer: IndentedWriter; insideTable: boolean; boldRequested: boolean; italicRequested: boolean; writingBold: boolean; writingItalic: boolean; options: TOptions; } /** * Renders MarkupElement content in the Markdown file format. * For more info: https://en.wikipedia.org/wiki/Markdown */ export declare class MarkdownEmitter { emit(stringBuilder: StringBuilder, docNode: DocNode, options: IMarkdownEmitterOptions): string; protected getEscapedText(text: string): string; protected getTableEscapedText(text: string): string; /** * @virtual */ protected writeNode(docNode: DocNode, context: IMarkdownEmitterContext, docNodeSiblings: boolean): void; /** @virtual */ protected writeLinkTagWithCodeDestination(docLinkTag: DocLinkTag, context: IMarkdownEmitterContext): void; /** @virtual */ protected writeLinkTagWithUrlDestination(docLinkTag: DocLinkTag, context: IMarkdownEmitterContext): void; protected writePlainText(text: string, context: IMarkdownEmitterContext): void; protected writeNodes(docNodes: ReadonlyArray, context: IMarkdownEmitterContext): void; }