Add JsDoc comments to the components

diff --git a/ts/WoltLabSuite/Core/Api/Error.ts b/ts/WoltLabSuite/Core/Api/Error.ts
index 36078cbddfa1340931b2d162c2317dddb727ddb5..7ea2b4e81db5c268a0b02d2b0a0f044fc3750d26 100644 (file)
--- a/ts/WoltLabSuite/Core/Api/Error.ts
+++ b/ts/WoltLabSuite/Core/Api/Error.ts
@@ -1,3 +1,12 @@
+/**
+ * Represents an error from a failed request to an API endpoint.
+ *
+ * @author Alexander Ebert
+ * @copyright 2001-2024 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.1
+ */
+
 type RequestFailureType = "api_error" | "invalid_request_error";
 
 export class ApiError {

diff --git a/ts/WoltLabSuite/Core/Api/Messages/MentionSuggestions.ts b/ts/WoltLabSuite/Core/Api/Messages/MentionSuggestions.ts
index 01d61a1d38cacb6817e20e826606414f62d92b80..98838157a8ed5f671f106142828127c0529f48ab 100644 (file)
--- a/ts/WoltLabSuite/Core/Api/Messages/MentionSuggestions.ts
+++ b/ts/WoltLabSuite/Core/Api/Messages/MentionSuggestions.ts
@@ -1,3 +1,13 @@
+/**
+ * Requests the list of users and groups that match the provided query string.
+ *
+ * @author Alexander Ebert
+ * @copyright 2001-2024 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.1
+ * @woltlabExcludeBundle tiny
+ */
+
 import { prepareRequest } from "WoltLabSuite/Core/Ajax/Backend";
 import { ApiResult, apiResultFromError, apiResultFromValue } from "../Result";
 

diff --git a/ts/WoltLabSuite/Core/Api/Result.ts b/ts/WoltLabSuite/Core/Api/Result.ts
index 92fb7b3b6748da511e12a3bcb255202fd52d88f0..4019947e5ac162d8812212a7c538dbb461f6b54b 100644 (file)
--- a/ts/WoltLabSuite/Core/Api/Result.ts
+++ b/ts/WoltLabSuite/Core/Api/Result.ts
@@ -1,3 +1,14 @@
+/**
+ * Represents the result of a request to an API endpoint and provides functions
+ * to create the result itself. Unwrapping the result through `.unwrap()` is
+ * useful in situations where there should formally never an error.
+ *
+ * @author Alexander Ebert
+ * @copyright 2001-2024 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.1
+ */
+
 import { StatusNotOk } from "../Ajax/Error";
 import { isPlainObject } from "../Core";
 import { ApiError } from "./Error";

diff --git a/ts/WoltLabSuite/Core/Api/Sessions/DeleteSession.ts b/ts/WoltLabSuite/Core/Api/Sessions/DeleteSession.ts
index b7c37fe7302621b9169c9bad39127b8a0666c6b5..aca60c618922670e7041e8c87789e53b5ae06020 100644 (file)
--- a/ts/WoltLabSuite/Core/Api/Sessions/DeleteSession.ts
+++ b/ts/WoltLabSuite/Core/Api/Sessions/DeleteSession.ts
@@ -1,3 +1,14 @@
+/**
+ * Deletes a user’s session, effectively forcing a device with that session id
+ * to be logged out.
+ *
+ * @author Alexander Ebert
+ * @copyright 2001-2024 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.1
+ * @woltlabExcludeBundle tiny
+ */
+
 import { prepareRequest } from "WoltLabSuite/Core/Ajax/Backend";
 import { ApiResult, apiResultFromError, apiResultFromValue } from "../Result";
 

diff --git a/wcfsetup/install/files/js/WoltLabSuite/Core/Api/Error.js b/wcfsetup/install/files/js/WoltLabSuite/Core/Api/Error.js
index 3360323316b910877df437f3d481168197b5cce4..640e2de721b3d2bbf57974943a92c457b646609b 100644 (file)
--- a/wcfsetup/install/files/js/WoltLabSuite/Core/Api/Error.js
+++ b/wcfsetup/install/files/js/WoltLabSuite/Core/Api/Error.js
@@ -1,3 +1,11 @@
+/**
+ * Represents an error from a failed request to an API endpoint.
+ *
+ * @author Alexander Ebert
+ * @copyright 2001-2024 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.1
+ */
 define(["require", "exports"], function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });

diff --git a/wcfsetup/install/files/js/WoltLabSuite/Core/Api/Messages/MentionSuggestions.js b/wcfsetup/install/files/js/WoltLabSuite/Core/Api/Messages/MentionSuggestions.js
index d2f0251dddd47c0ca2f6a9cca84d36506b0740a4..0d6eb9c2c810a6c7acf4d80d60820d8e91175a11 100644 (file)
--- a/wcfsetup/install/files/js/WoltLabSuite/Core/Api/Messages/MentionSuggestions.js
+++ b/wcfsetup/install/files/js/WoltLabSuite/Core/Api/Messages/MentionSuggestions.js
@@ -1,3 +1,12 @@
+/**
+ * Requests the list of users and groups that match the provided query string.
+ *
+ * @author Alexander Ebert
+ * @copyright 2001-2024 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.1
+ * @woltlabExcludeBundle tiny
+ */
 define(["require", "exports", "WoltLabSuite/Core/Ajax/Backend", "../Result"], function (require, exports, Backend_1, Result_1) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });

diff --git a/wcfsetup/install/files/js/WoltLabSuite/Core/Api/Result.js b/wcfsetup/install/files/js/WoltLabSuite/Core/Api/Result.js
index 2dce313e226f4cde882a3c33a0a307861cfedbbf..2e01a3a00d80d15f8029137b3da7e2036e2e1911 100644 (file)
--- a/wcfsetup/install/files/js/WoltLabSuite/Core/Api/Result.js
+++ b/wcfsetup/install/files/js/WoltLabSuite/Core/Api/Result.js
@@ -1,3 +1,13 @@
+/**
+ * Represents the result of a request to an API endpoint and provides functions
+ * to create the result itself. Unwrapping the result through `.unwrap()` is
+ * useful in situations where there should formally never an error.
+ *
+ * @author Alexander Ebert
+ * @copyright 2001-2024 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.1
+ */
 define(["require", "exports", "../Core", "./Error"], function (require, exports, Core_1, Error_1) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });

diff --git a/wcfsetup/install/files/js/WoltLabSuite/Core/Api/Sessions/DeleteSession.js b/wcfsetup/install/files/js/WoltLabSuite/Core/Api/Sessions/DeleteSession.js
index 5df2e8975125110d2737fc95aa65dc321f848ca2..b3e953f8367c878748af788a72c80c676808c7bf 100644 (file)
--- a/wcfsetup/install/files/js/WoltLabSuite/Core/Api/Sessions/DeleteSession.js
+++ b/wcfsetup/install/files/js/WoltLabSuite/Core/Api/Sessions/DeleteSession.js
@@ -1,3 +1,13 @@
+/**
+ * Deletes a user’s session, effectively forcing a device with that session id
+ * to be logged out.
+ *
+ * @author Alexander Ebert
+ * @copyright 2001-2024 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.1
+ * @woltlabExcludeBundle tiny
+ */
 define(["require", "exports", "WoltLabSuite/Core/Ajax/Backend", "../Result"], function (require, exports, Backend_1, Result_1) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });