refactor: update jsdoc comments

alexander-akait · alexander-akait · commit e2addd51531b · 2026-04-29T15:46:03.000+03:00
diff --git a/lib/CompatSource.js b/lib/CompatSource.js
@@ -54,6 +54,9 @@ class CompatSource extends Source {
 		return this._sourceLike.source();
 	}
 
+	/**
+	 * @returns {Buffer} buffer
+	 */
 	buffer() {
 		if (typeof this._sourceLike.buffer === "function") {
 			return this._sourceLike.buffer();
@@ -71,6 +74,9 @@ class CompatSource extends Source {
 		return super.buffers();
 	}
 
+	/**
+	 * @returns {number} size
+	 */
 	size() {
 		if (typeof this._sourceLike.size === "function") {
 			return this._sourceLike.size();
diff --git a/lib/ConcatSource.js b/lib/ConcatSource.js
@@ -88,6 +88,9 @@ class ConcatSource extends Source {
 		}
 	}
 
+	/**
+	 * @returns {Buffer} buffer
+	 */
 	buffer() {
 		return Buffer.concat(this.buffers());
 	}
@@ -140,6 +143,9 @@ class ConcatSource extends Source {
 		return source;
 	}
 
+	/**
+	 * @returns {number} size
+	 */
 	size() {
 		if (!this._isOptimized) this._optimize();
 		const children = /** @type {Source[]} */ (this._children);
diff --git a/lib/OriginalSource.js b/lib/OriginalSource.js
@@ -71,6 +71,9 @@ class OriginalSource extends Source {
 		return this._value;
 	}
 
+	/**
+	 * @returns {Buffer} buffer
+	 */
 	buffer() {
 		if (this._valueAsBuffer === undefined) {
 			const value = Buffer.from(/** @type {string} */ (this._value), "utf8");
@@ -83,10 +86,7 @@ class OriginalSource extends Source {
 	}
 
 	/**
-	 * Override Source.prototype.size (= `this.buffer().length`) to avoid
-	 * allocating a Buffer just to read the byte length, and memoize the
-	 * result so repeated calls don't re-scan the string.
-	 * @returns {number} byte length
+	 * @returns {number} size
 	 */
 	size() {
 		if (this._cachedSize !== undefined) return this._cachedSize;
diff --git a/lib/RawSource.js b/lib/RawSource.js
@@ -82,6 +82,9 @@ class RawSource extends Source {
 		return this._value;
 	}
 
+	/**
+	 * @returns {Buffer} buffer
+	 */
 	buffer() {
 		if (this._valueAsBuffer === undefined) {
 			const value = Buffer.from(/** @type {string} */ (this._value), "utf8");
@@ -94,10 +97,7 @@ class RawSource extends Source {
 	}
 
 	/**
-	 * Override Source.prototype.size (= `this.buffer().length`) to avoid
-	 * allocating a Buffer just to read the byte length, and memoize the
-	 * result so repeated calls don't re-scan the string.
-	 * @returns {number} byte length
+	 * @returns {number} size
 	 */
 	size() {
 		if (this._cachedSize !== undefined) return this._cachedSize;
diff --git a/lib/SizeOnlySource.js b/lib/SizeOnlySource.js
@@ -31,6 +31,9 @@ class SizeOnlySource extends Source {
 		);
 	}
 
+	/**
+	 * @returns {number} size
+	 */
 	size() {
 		return this._size;
 	}
diff --git a/lib/Source.js b/lib/Source.js
@@ -62,6 +62,9 @@ class Source {
 		return [this.buffer()];
 	}
 
+	/**
+	 * @returns {number} size
+	 */
 	size() {
 		return this.buffer().length;
 	}
diff --git a/lib/SourceMapSource.js b/lib/SourceMapSource.js
@@ -129,6 +129,9 @@ class SourceMapSource extends Source {
 		];
 	}
 
+	/**
+	 * @returns {Buffer} buffer
+	 */
 	buffer() {
 		if (this._valueAsBuffer === undefined) {
 			const value = Buffer.from(
@@ -144,10 +147,7 @@ class SourceMapSource extends Source {
 	}
 
 	/**
-	 * Override Source.prototype.size (= `this.buffer().length`) to avoid
-	 * allocating a Buffer just to read the byte length, and memoize the
-	 * result so repeated calls don't re-scan the string.
-	 * @returns {number} byte length
+	 * @returns {number} size
 	 */
 	size() {
 		if (this._cachedSize !== undefined) return this._cachedSize;

Original file line number	Diff line number	Diff line change
`@@ -88,6 +88,9 @@ class ConcatSource extends Source {`
`88`	`88`	`}`
`89`	`89`	`}`
`90`	`90`
	`91`	`+ /**`
	`92`	`+ * @returns {Buffer} buffer`
	`93`	`+ */`
`91`	`94`	`buffer() {`
`92`	`95`	`return Buffer.concat(this.buffers());`
`93`	`96`	`}`
`@@ -140,6 +143,9 @@ class ConcatSource extends Source {`
`140`	`143`	`return source;`
`141`	`144`	`}`
`142`	`145`
	`146`	`+ /**`
	`147`	`+ * @returns {number} size`
	`148`	`+ */`
`143`	`149`	`size() {`
`144`	`150`	`if (!this._isOptimized) this._optimize();`
`145`	`151`	`const children = /** @type {Source[]} */ (this._children);`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,9 @@ class SizeOnlySource extends Source {`
`31`	`31`	`);`
`32`	`32`	`}`
`33`	`33`
	`34`	`+ /**`
	`35`	`+ * @returns {number} size`
	`36`	`+ */`
`34`	`37`	`size() {`
`35`	`38`	`return this._size;`
`36`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,9 @@ class Source {`
`62`	`62`	`return [this.buffer()];`
`63`	`63`	`}`
`64`	`64`
	`65`	`+ /**`
	`66`	`+ * @returns {number} size`
	`67`	`+ */`
`65`	`68`	`size() {`
`66`	`69`	`return this.buffer().length;`
`67`	`70`	`}`