docs: fix errors in TSDocs

sr258 · sr258 · commit 3ccb56f6e598 · 2025-03-16T19:50:32.000+01:00
diff --git a/docs/advanced/cluster.md b/docs/advanced/cluster.md
@@ -56,7 +56,7 @@ docker-compose down -v
 ## How it works
 
 The `docker-compose.yml` file configures a setup in which there are several
-services that make {@link "@lumieducation/h5p-server} work in cluster mode:
+services that make {@link "@lumieducation/h5p-server"} work in cluster mode:
 
 - Minio (provides S3 storage backend for content, temporary and library files)
 - MongoDB (provides database backend for content and library metadata)
diff --git a/packages/h5p-mongos3/src/MongoLibraryStorage.ts b/packages/h5p-mongos3/src/MongoLibraryStorage.ts
@@ -109,7 +109,7 @@ export default class MongoLibraryStorage implements ILibraryStorage {
      * Adds the metadata of the library to the repository and assigns a new id
      * to the installed library. This id is used later when the library must be
      * referenced somewhere. Throws errors if something goes wrong.
-     * @param libraryMetadata The library metadata object (= content of
+     * @param libraryData The library metadata object (= content of
      * library.json)
      * @param restricted True if the library can only be used be users allowed
      * to install restricted libraries.
@@ -434,10 +434,10 @@ export default class MongoLibraryStorage implements ILibraryStorage {
     }
 
     /**
-     * Returns a information about a library file.
-     * Throws an exception if the file does not exist.
+     * Returns a information about a library file. Throws an exception if the
+     * file does not exist.
      * @param library library
-     * @param filename the relative path inside the library
+     * @param file the relative path inside the library
      * @returns the file stats
      */
     public async getFileStats(
@@ -495,7 +495,7 @@ export default class MongoLibraryStorage implements ILibraryStorage {
      * Returns a readable stream of a library file's contents.
      * Throws an exception if the file does not exist.
      * @param library library
-     * @param filename the relative path inside the library
+     * @param file the relative path inside the library
      * @returns a readable stream of the file's contents
      */
     public async getFileStream(
diff --git a/packages/h5p-mongos3/src/MongoS3ContentStorage.ts b/packages/h5p-mongos3/src/MongoS3ContentStorage.ts
@@ -343,7 +343,7 @@ export default class MongoS3ContentStorage implements IContentStorage {
     /**
      * Returns information about a content file (e.g. image or video) inside a
      * piece of content.
-     * @param id the id of the content object that the file is attached to
+     * @param contentId the id of the content object that the file is attached to
      * @param filename the filename of the file to get information about
      * @param user the user who wants to retrieve the content file
      * @returns
diff --git a/packages/h5p-mongos3/src/MongoS3LibraryStorage.ts b/packages/h5p-mongos3/src/MongoS3LibraryStorage.ts
@@ -83,7 +83,7 @@ export default class MongoS3LibraryStorage implements ILibraryStorage {
      * up the partly installed library.
      * @param library The library that is being installed
      * @param filename Filename of the file to add, relative to the library root
-     * @param stream The stream containing the file content
+     * @param readStream The stream containing the file content
      * @returns true if successful
      */
     public async addFile(
@@ -127,7 +127,7 @@ export default class MongoS3LibraryStorage implements ILibraryStorage {
      * Adds the metadata of the library to the repository and assigns a new id
      * to the installed library. This id is used later when the library must be
      * referenced somewhere. Throws errors if something goes wrong.
-     * @param libraryMetadata The library metadata object (= content of
+     * @param libraryData The library metadata object (= content of
      * library.json)
      * @param restricted True if the library can only be used be users allowed
      * to install restricted libraries.
@@ -441,7 +441,7 @@ export default class MongoS3LibraryStorage implements ILibraryStorage {
      * Returns a information about a library file.
      * Throws an exception if the file does not exist.
      * @param library library
-     * @param filename the relative path inside the library
+     * @param file the relative path inside the library
      * @returns the file stats
      */
     public async getFileStats(
@@ -475,7 +475,7 @@ export default class MongoS3LibraryStorage implements ILibraryStorage {
      * Returns a readable stream of a library file's contents.
      * Throws an exception if the file does not exist.
      * @param library library
-     * @param filename the relative path inside the library
+     * @param file the relative path inside the library
      * @returns a readable stream of the file's contents
      */
     public async getFileStream(
@@ -659,8 +659,8 @@ export default class MongoS3LibraryStorage implements ILibraryStorage {
     /**
      * Gets a list of all library files that exist for this library.
      * @param library the library name
-     * @param withMetadata true if the 'library.json' file should be included in
-     * the list
+     * @param options set `withMetadata` to `true` if the `library.json` file
+     * should be included in the list
      * @returns all files that exist for the library
      */
     public async listFiles(
diff --git a/packages/h5p-mongos3/src/S3TemporaryFileStorage.ts b/packages/h5p-mongos3/src/S3TemporaryFileStorage.ts
@@ -77,7 +77,7 @@ export default class S3TemporaryFileStorage implements ITemporaryFileStorage {
      * Deletes the file from temporary storage.
      * Throws errors of something goes wrong.
      * @param filename the file to delete
-     * @param userId the user ID of the user who wants to delete the file
+     * @param _ownerId the user ID of the user who wants to delete the file
      */
     public async deleteFile(filename: string, _ownerId: string): Promise<void> {
         log.debug(`Deleting file "${filename}" from temporary storage.`);
@@ -108,7 +108,7 @@ export default class S3TemporaryFileStorage implements ITemporaryFileStorage {
     /**
      * Checks if a file exists in temporary storage.
      * @param filename the file to check
-     * @param user the user who wants to access the file
+     * @param _user the user who wants to access the file
      */
     public async fileExists(filename: string, _user: IUser): Promise<boolean> {
         log.debug(`Checking if file ${filename} exists in temporary storage.`);
@@ -144,7 +144,7 @@ export default class S3TemporaryFileStorage implements ITemporaryFileStorage {
      * Returns a information about a temporary file.
      * Throws an exception if the file does not exist.
      * @param filename the relative path inside the library
-     * @param user the user who wants to access the file
+     * @param _user the user who wants to access the file
      * @returns the file stats
      */
     public async getFileStats(
diff --git a/packages/h5p-mongos3/src/initMongo.ts b/packages/h5p-mongos3/src/initMongo.ts
@@ -5,17 +5,17 @@ import { Logger } from '@lumieducation/h5p-server';
 const log = new Logger('initMongo');
 
 /**
- * Creates a MongoDB client.
- * You must either pass the configuration values through the parameters or set
- * them as environment variables.
- * @param url (optional) the connection URL for MongoDB (e.g. mongodb://localhost:27105)
- * Can also be set through the environment variable MONGODB_URL.
- * @param db (optional) the DB
- * Can also be set through the environment variable MONGODB_DB.
- * @param user (optional) a MongoDB user that can read and write the database
- * Can also be set through the environment variable MONGODB_USER.
- * @param password (optional) the password for the MongoDB user
- * Can also be set through the environment variable MONGODB_PASSWORD.
+ * Creates a MongoDB client. You must either pass the configuration values
+ * through the parameters or set them as environment variables.
+ * @param url (optional) the connection URL for MongoDB (e.g.
+ * mongodb://localhost:27105) Can also be set through the environment variable
+ * MONGODB_URL.
+ * @param db (optional) the DB Can also be set through the environment variable
+ * MONGODB_DB.
+ * @param username (optional) a MongoDB user that can read and write the
+ * database Can also be set through the environment variable MONGODB_USER.
+ * @param password (optional) the password for the MongoDB user Can also be set
+ * through the environment variable MONGODB_PASSWORD.
  * @returns the MongoDB client
  */
 export default async (
diff --git a/packages/h5p-server/src/ContentFileScanner.ts b/packages/h5p-server/src/ContentFileScanner.ts
@@ -66,8 +66,8 @@ export class ContentFileScanner extends ContentScanner {
      * Loads the specified content from the ContentManager and scans its
      * parameters (= content.json) for references to local files (= audio,
      * video, images, generic files).
-     * @param contentId the content to scan
-     * @param user the user who wants to access the file
+     * @param mainParams the parameters of the content to scan
+     * @param mainLibraryName the library name of the content in the parameters
      * @returns a list of local files
      */
     public async scanForFiles(
diff --git a/packages/h5p-server/src/helpers/AggregateH5pError.ts b/packages/h5p-server/src/helpers/AggregateH5pError.ts
@@ -5,9 +5,6 @@ import H5pError from './H5pError';
  * the execution has to be stopped stopped right away.
  */
 export default class AggregateH5pError extends H5pError {
-    /**
-     * @param firstError (optional) the first error
-     */
     constructor(
         errorId: string,
         replacements: { [key: string]: string },
