JSDoc, closes #5874

server/middlewares/authentication.ts

@@ -14,9 +14,9 @@ import {
 } from "../errors";
 
 type AuthenticationOptions = {
-  /* An admin user role is required to access the route */
+  /** An admin user role is required to access the route */
   admin?: boolean;
-  /* A member or admin user role is required to access the route */
+  /** A member or admin user role is required to access the route */
   member?: boolean;
   /**
    * Authentication is parsed, but optional. Note that if a token is provided

server/queues/tasks/CleanupExpiredFileOperationsTask.test.ts

@@ -19,7 +19,6 @@ describe("CleanupExpiredFileOperationsTask", () => {
       state: FileOperationState.Complete,
     });
 
-    /* This is a test helper that creates a new task and runs it. */
     const task = new CleanupExpiredFileOperationsTask();
     await task.perform({ limit: 100 });
 

server/queues/tasks/ErrorTimedOutFileOperationsTask.test.ts

@@ -19,7 +19,6 @@ describe("ErrorTimedOutFileOperationsTask", () => {
       state: FileOperationState.Complete,
     });
 
-    /* This is a test helper that creates a new task and runs it. */
     const task = new ErrorTimedOutFileOperationsTask();
     await task.perform({ limit: 100 });
 

server/queues/tasks/UploadTeamAvatarTask.ts

@@ -4,9 +4,9 @@ import FileStorage from "@server/storage/files";
 import BaseTask, { TaskPriority } from "./BaseTask";
 
 type Props = {
-  /* The teamId to operate on */
+  /** The teamId to operate on */
   teamId: string;
-  /* The original avatarUrl from the SSO provider */
+  /** The original avatarUrl from the SSO provider */
   avatarUrl: string;
 };
 

server/queues/tasks/UploadUserAvatarTask.ts

@@ -4,9 +4,9 @@ import FileStorage from "@server/storage/files";
 import BaseTask, { TaskPriority } from "./BaseTask";
 
 type Props = {
-  /* The userId to operate on */
+  /** The userId to operate on */
   userId: string;
-  /* The original avatarUrl from the SSO provider */
+  /** The original avatarUrl from the SSO provider */
   avatarUrl: string;
 };
 

server/types.ts

@@ -391,15 +391,15 @@ export type NotificationMetadata = {
 };
 
 export type JSONExportMetadata = {
-  /* The version of the export, allows updated structure in the future. */
+  /** The version of the export, allows updated structure in the future. */
   exportVersion: number;
-  /* The version of the application that created the export. */
+  /** The version of the application that created the export. */
   version: string;
-  /* The date the export was created. */
+  /** The date the export was created. */
   createdAt: string;
-  /* The ID of the user that created the export. */
+  /** The ID of the user that created the export. */
   createdById: string;
-  /* The email of the user that created the export. */
+  /** The email of the user that created the export. */
   createdByEmail: string | null;
 };
 

server/utils/azure.ts

@@ -3,7 +3,7 @@ import env from "@server/env";
 import OAuthClient from "./oauth";
 
 type AzurePayload = {
-  /* A GUID that represents the Azure AD tenant that the user is from */
+  /** A GUID that represents the Azure AD tenant that the user is from */
   tid: string;
 };