@microsoft/tsdoc
Version:
A parser for the TypeScript doc comment syntax
72 lines • 3.16 kB
JavaScript
;
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.
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 (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
if (typeof b !== "function" && b !== null)
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
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.DocSoftBreak = void 0;
var DocNode_1 = require("./DocNode");
var DocExcerpt_1 = require("./DocExcerpt");
/**
* Instructs a renderer to insert an explicit newline in the output.
* (Normally the renderer uses a formatting rule to determine where
* lines should wrap.)
*
* @remarks
* In HTML, a soft break is represented as an ASCII newline character (which does not
* affect the web browser's view), whereas the hard break is the `<br />` element
* (which starts a new line in the web browser's view).
*
* TSDoc follows the same conventions, except the renderer avoids emitting
* two empty lines (because that could start a new CommonMark paragraph).
*/
var DocSoftBreak = /** @class */ (function (_super) {
__extends(DocSoftBreak, _super);
/**
* Don't call this directly. Instead use {@link TSDocParser}
* @internal
*/
function DocSoftBreak(parameters) {
var _this = _super.call(this, parameters) || this;
if (DocNode_1.DocNode.isParsedParameters(parameters)) {
// The type is IDocNodeParsedParameters, which is a base of IDocSoftBreakParsedParameters
// but not a base of IDocSoftBreakParameters. Therefore the type must be IDocSoftBreakParsedParameters.
// TypeScript 4 could infer this, but for some reason TypeScript 5 cannot.
var parsedParameters = parameters;
_this._softBreakExcerpt = new DocExcerpt_1.DocExcerpt({
configuration: _this.configuration,
excerptKind: DocExcerpt_1.ExcerptKind.SoftBreak,
content: parsedParameters.softBreakExcerpt
});
}
return _this;
}
Object.defineProperty(DocSoftBreak.prototype, "kind", {
/** @override */
get: function () {
return DocNode_1.DocNodeKind.SoftBreak;
},
enumerable: false,
configurable: true
});
/** @override */
DocSoftBreak.prototype.onGetChildNodes = function () {
return [this._softBreakExcerpt];
};
return DocSoftBreak;
}(DocNode_1.DocNode));
exports.DocSoftBreak = DocSoftBreak;
//# sourceMappingURL=DocSoftBreak.js.map