Spaces:
Sleeping
Sleeping
File size: 1,145 Bytes
31248b9 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 | // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.
import { DocNodeKind, DocNode } from './DocNode';
import { DocSection } from './DocSection';
/**
* Represents a section that is introduced by a TSDoc block tag.
* For example, an `@example` block.
*/
export class DocBlock extends DocNode {
/**
* Don't call this directly. Instead use {@link TSDocParser}
* @internal
*/
constructor(parameters) {
super(parameters);
this._blockTag = parameters.blockTag;
this._content = new DocSection({ configuration: this.configuration });
}
/** @override */
get kind() {
return DocNodeKind.Block;
}
/**
* The TSDoc tag that introduces this section.
*/
get blockTag() {
return this._blockTag;
}
/**
* The TSDoc tag that introduces this section.
*/
get content() {
return this._content;
}
/** @override */
onGetChildNodes() {
return [this.blockTag, this._content];
}
}
//# sourceMappingURL=DocBlock.js.map |