1 | import { type IDocNodeParameters, DocNode } from '@microsoft/tsdoc';
|
2 | /**
|
3 | * Constructor parameters for {@link DocHeading}.
|
4 | */
|
5 | export interface IDocHeadingParameters extends IDocNodeParameters {
|
6 | title: string;
|
7 | level?: number;
|
8 | }
|
9 | /**
|
10 | * Represents a section header similar to an HTML `<h1>` or `<h2>` element.
|
11 | */
|
12 | export declare class DocHeading extends DocNode {
|
13 | readonly title: string;
|
14 | readonly level: number;
|
15 | /**
|
16 | * Don't call this directly. Instead use {@link TSDocParser}
|
17 | * @internal
|
18 | */
|
19 | constructor(parameters: IDocHeadingParameters);
|
20 | /** @override */
|
21 | get kind(): string;
|
22 | }
|
23 | //# sourceMappingURL=DocHeading.d.ts.map |
\ | No newline at end of file |