[js] fix jsdoc comments

2024-02-11 14:56:48 +08:00 · 2024-02-11 14:56:48 +08:00 · 1ff3a56ef3
commit 1ff3a56ef3
parent cdd6564b51
2 changed files with 7 additions and 1 deletions
--- a/shared/error-utils/index.mjs
+++ b/shared/error-utils/index.mjs
@ -1,4 +1,10 @@
+/**
+ * Represents an error that is thrown when the calling a pure virtual method.
+ * @class
+ * @extends {Error}
+ */
 export class VirtualMethodNotImplementedError extends Error {
+	/** @constructor */
 	constructor() {
 		super('virtual method not implemented.');
 	}
--- a/shared/utility/queue.mjs
+++ b/shared/utility/queue.mjs
@ -102,7 +102,7 @@ export class Queue {

    /**
     * Returns an iterator that allows iterating through the elements of the queue.
-     * @returns {*} elements of the queue.
+     * @yields {*} elements of the queue.
     * @generator
     */
    *[Symbol.iterator]() {