@microsoft/tsdoc
Version:
A parser for the TypeScript doc comment syntax
63 lines • 2.38 kB
JavaScript
;
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 __());
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.DocInheritDocTag = void 0;
var DocNode_1 = require("./DocNode");
var DocInlineTagBase_1 = require("./DocInlineTagBase");
/**
* Represents an `{@inheritDoc}` tag.
*/
var DocInheritDocTag = /** @class */ (function (_super) {
__extends(DocInheritDocTag, _super);
/**
* Don't call this directly. Instead use {@link TSDocParser}
* @internal
*/
function DocInheritDocTag(parameters) {
var _this = _super.call(this, parameters) || this;
if (_this.tagNameWithUpperCase !== '@INHERITDOC') {
throw new Error('DocInheritDocTag requires the tag name to be "{@inheritDoc}"');
}
_this._declarationReference = parameters.declarationReference;
return _this;
}
Object.defineProperty(DocInheritDocTag.prototype, "kind", {
/** @override */
get: function () {
return DocNode_1.DocNodeKind.InheritDocTag;
},
enumerable: false,
configurable: true
});
Object.defineProperty(DocInheritDocTag.prototype, "declarationReference", {
/**
* The declaration that the documentation will be inherited from.
* If omitted, the documentation will be inherited from the parent class.
*/
get: function () {
return this._declarationReference;
},
enumerable: false,
configurable: true
});
/** @override */
DocInheritDocTag.prototype.getChildNodesForContent = function () {
// abstract
return [this._declarationReference];
};
return DocInheritDocTag;
}(DocInlineTagBase_1.DocInlineTagBase));
exports.DocInheritDocTag = DocInheritDocTag;
//# sourceMappingURL=DocInheritDocTag.js.map