@microsoft/api-documenter
Version:
Read JSON files from api-extractor, generate documentation pages
22 lines • 807 B
JavaScript
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.
import { DocNode, DocSection } from '@microsoft/tsdoc';
import { CustomDocNodeKind } from './CustomDocNodeKind';
/**
* Represents a note box, which is typically displayed as a bordered box containing informational text.
*/
export class DocNoteBox extends DocNode {
constructor(parameters, sectionChildNodes) {
super(parameters);
this.content = new DocSection({ configuration: this.configuration }, sectionChildNodes);
}
/** @override */
get kind() {
return CustomDocNodeKind.NoteBox;
}
/** @override */
onGetChildNodes() {
return [this.content];
}
}
//# sourceMappingURL=DocNoteBox.js.map