@lpc-lang/core
Version:
LPC Language Compiler Library
17 lines • 1.45 kB
TypeScript
import * as Proto from "../server/_namespaces/lpc.server.protocol.js";
import { protocol } from "../server/_namespaces/lpc.server.js";
import { SymbolDisplayPart } from "../server/_namespaces/lpc.js";
import { URI } from "vscode-uri";
import { MarkdownString } from "./MarkdownString.js";
export interface IFilePathToResourceConverter {
/**
* Convert a typescript filepath to a VS Code resource.
*/
toResource(filepath: string): URI;
}
export declare function tagsToMarkdown(tags: readonly Proto.JSDocTagInfo[], filePathConverter: IFilePathToResourceConverter): string;
export declare function asPlainTextWithLinks(parts: readonly SymbolDisplayPart[] | string, filePathConverter: IFilePathToResourceConverter): string;
export declare function appendDocumentationAsMarkdown(documentation: readonly SymbolDisplayPart[] | string | undefined, tags: readonly Proto.JSDocTagInfo[] | undefined, converter: IFilePathToResourceConverter): string;
export declare function documentationToMarkdown(documentation: readonly SymbolDisplayPart[] | string, tags: readonly Proto.JSDocTagInfo[], filePathConverter: IFilePathToResourceConverter, baseUri: URI | undefined): string;
export declare function addMarkdownDocumentation(out: MarkdownString, documentation: string | SymbolDisplayPart[] | undefined, tags: protocol.JSDocTagInfo[] | undefined, converter: IFilePathToResourceConverter): MarkdownString;
//# sourceMappingURL=textRendering.d.ts.map