UNPKG

@ng-doc/builder

Version:

<!-- PROJECT LOGO --> <br /> <div align="center"> <a href="https://github.com/ng-doc/ng-doc"> <img src="https://ng-doc.com/assets/images/ng-doc.svg?raw=true" alt="Logo" height="150px"> </a>

41 lines (40 loc) 975 B
import { type DocNode } from '@microsoft/tsdoc'; import { JSDocableNode } from 'ts-morph'; export declare class Formatter { static renderDocNode(docNode: DocNode): string; static renderDocNodes(docNodes: readonly DocNode[]): string; } /** * * @param node */ export declare function getJsDocDescription(node: JSDocableNode): string; /** * * @param node * @param tagName */ export declare function getJsDocTag(node: JSDocableNode, tagName: string): string; /** * * @param node * @param tagName */ export declare function getJsDocTags(node: JSDocableNode, tagName: string): string[]; /** * * @param node */ export declare function getAllJsDocTags(node: JSDocableNode): Record<string, string[]>; /** * * @param node * @param tagName */ export declare function hasJsDocTag(node: JSDocableNode, tagName: string): boolean; /** * * @param node * @param paramName */ export declare function getJsDocParam(node: JSDocableNode, paramName: string): string;