var __extends = (this && this.__extends) || (function () { var extendStatics = function (d, b) { extendStatics = Object.setPrototypeOf || ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) || function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; }; return extendStatics(d, b); }; return function (d, b) { extendStatics(d, b); function __() { this.constructor = d; } d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __()); }; })(); var __spreadArrays = (this && this.__spreadArrays) || function () { for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length; for (var r = Array(s), k = 0, i = 0; i < il; i++) for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++) r[k] = a[j]; return r; }; import { DocNode, DocNodeKind } from './DocNode'; import { DocSection } from './DocSection'; import { StandardModifierTagSet } from '../details/StandardModifierTagSet'; import { StringBuilder } from '../emitters/StringBuilder'; import { TSDocEmitter } from '../emitters/TSDocEmitter'; import { DocParamCollection } from './DocParamCollection'; /** * Represents an entire documentation comment conforming to the TSDoc structure. * This is the root of the DocNode tree. */ var DocComment = /** @class */ (function (_super) { __extends(DocComment, _super); /** * Don't call this directly. Instead use {@link TSDocParser} * @internal */ function DocComment(parameters) { var _this = _super.call(this, parameters) || this; _this.summarySection = new DocSection({ configuration: _this.configuration }); _this.remarksBlock = undefined; _this.privateRemarks = undefined; _this.deprecatedBlock = undefined; _this.params = new DocParamCollection({ configuration: _this.configuration }); _this.typeParams = new DocParamCollection({ configuration: _this.configuration }); _this.returnsBlock = undefined; _this.modifierTagSet = new StandardModifierTagSet(); _this._seeBlocks = []; _this._customBlocks = []; return _this; } Object.defineProperty(DocComment.prototype, "kind", { /** @override */ get: function () { return DocNodeKind.Comment; }, enumerable: false, configurable: true }); Object.defineProperty(DocComment.prototype, "seeBlocks", { /** * The collection of all `@see` DockBlockTag nodes belonging to this doc comment. */ get: function () { return this._seeBlocks; }, enumerable: false, configurable: true }); Object.defineProperty(DocComment.prototype, "customBlocks", { /** * The collection of all DocBlock nodes belonging to this doc comment. */ get: function () { return this._customBlocks; }, enumerable: false, configurable: true }); /** * Append an item to the seeBlocks collection. * @internal */ DocComment.prototype._appendSeeBlock = function (block) { this._seeBlocks.push(block); }; /** * Append an item to the customBlocks collection. */ DocComment.prototype.appendCustomBlock = function (block) { this._customBlocks.push(block); }; /** @override */ DocComment.prototype.onGetChildNodes = function () { return __spreadArrays([ this.summarySection, this.remarksBlock, this.privateRemarks, this.deprecatedBlock, this.params.count > 0 ? this.params : undefined, this.typeParams.count > 0 ? this.typeParams : undefined, this.returnsBlock ], this.customBlocks, this.seeBlocks, [ this.inheritDocTag ], this.modifierTagSet.nodes); }; /** * Generates a doc comment corresponding to the `DocComment` tree. The output is in a normalized form, * and may ignore formatting/spacing from the original input. * * @remarks * After parsing a string, and possibly modifying the result, `emitAsTsdoc()` can be used to render the result * as a doc comment in a normalized format. It can also be used to emit a `DocComment` tree that was constructed * manually. * * This method is provided as convenience for simple use cases. To customize the output, or if you need * to render into a `StringBuilder`, use the {@link TSDocEmitter} class instead. */ DocComment.prototype.emitAsTsdoc = function () { var stringBuilder = new StringBuilder(); var emitter = new TSDocEmitter(); emitter.renderComment(stringBuilder, this); return stringBuilder.toString(); }; return DocComment; }(DocNode)); export { DocComment }; //# sourceMappingURL=DocComment.js.map