@microsoft/tsdoc
Version:
A parser for the TypeScript doc comment syntax
86 lines • 3.24 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.DocBlockTag = void 0;
var DocNode_1 = require("./DocNode");
var StringChecks_1 = require("../parser/StringChecks");
var DocExcerpt_1 = require("./DocExcerpt");
/**
* Represents a TSDoc block tag such as `@param` or `@public`.
*/
var DocBlockTag = /** @class */ (function (_super) {
__extends(DocBlockTag, _super);
/**
* Don't call this directly. Instead use {@link TSDocParser}
* @internal
*/
function DocBlockTag(parameters) {
var _this = _super.call(this, parameters) || this;
StringChecks_1.StringChecks.validateTSDocTagName(parameters.tagName);
_this._tagName = parameters.tagName;
_this._tagNameWithUpperCase = parameters.tagName.toUpperCase();
if (DocNode_1.DocNode.isParsedParameters(parameters)) {
_this._tagNameExcerpt = new DocExcerpt_1.DocExcerpt({
configuration: _this.configuration,
excerptKind: DocExcerpt_1.ExcerptKind.BlockTag,
content: parameters.tagNameExcerpt
});
}
return _this;
}
Object.defineProperty(DocBlockTag.prototype, "kind", {
/** @override */
get: function () {
return DocNode_1.DocNodeKind.BlockTag;
},
enumerable: false,
configurable: true
});
Object.defineProperty(DocBlockTag.prototype, "tagName", {
/**
* The TSDoc tag name. TSDoc tag names start with an at-sign (`@`) followed
* by ASCII letters using "camelCase" capitalization.
*/
get: function () {
return this._tagName;
},
enumerable: false,
configurable: true
});
Object.defineProperty(DocBlockTag.prototype, "tagNameWithUpperCase", {
/**
* The TSDoc tag name in all capitals, which is used for performing
* case-insensitive comparisons or lookups.
*/
get: function () {
return this._tagNameWithUpperCase;
},
enumerable: false,
configurable: true
});
/** @override */
DocBlockTag.prototype.onGetChildNodes = function () {
return [this._tagNameExcerpt];
};
DocBlockTag.prototype.getTokenSequence = function () {
if (!this._tagNameExcerpt) {
throw new Error('DocBlockTag.getTokenSequence() failed because this object did not originate from a parsed input');
}
return this._tagNameExcerpt.content;
};
return DocBlockTag;
}(DocNode_1.DocNode));
exports.DocBlockTag = DocBlockTag;
//# sourceMappingURL=DocBlockTag.js.map