From 1ff3a56ef34fff0af1b4c95ae4f3d5f710e9d45f Mon Sep 17 00:00:00 2001 From: szdytom Date: Sun, 11 Feb 2024 14:56:48 +0800 Subject: [PATCH] [js] fix jsdoc comments --- shared/error-utils/index.mjs | 6 ++++++ shared/utility/queue.mjs | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/shared/error-utils/index.mjs b/shared/error-utils/index.mjs index 8a6f22f..3357e13 100644 --- 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.'); } diff --git a/shared/utility/queue.mjs b/shared/utility/queue.mjs index 96a9d08..9ff8574 100644 --- 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]() {