diff --git a/app/components/ContextMenu/MouseSafeArea.tsx b/app/components/ContextMenu/MouseSafeArea.tsx index 817ab14e9..53f13ecf0 100644 --- a/app/components/ContextMenu/MouseSafeArea.tsx +++ b/app/components/ContextMenu/MouseSafeArea.tsx @@ -2,17 +2,17 @@ import * as React from "react"; import { useMousePosition } from "~/hooks/useMousePosition"; type Positions = { - /* Sub-menu x */ + /** Sub-menu x */ x: number; - /* Sub-menu y */ + /** Sub-menu y */ y: number; - /* Sub-menu height */ + /** Sub-menu height */ h: number; - /* Sub-menu width */ + /** Sub-menu width */ w: number; - /* Mouse x */ + /** Mouse x */ mouseX: number; - /* Mouse y */ + /** Mouse y */ mouseY: number; }; diff --git a/app/components/HoverPreview/HoverPreview.tsx b/app/components/HoverPreview/HoverPreview.tsx index 304f0c38a..ff651bffb 100644 --- a/app/components/HoverPreview/HoverPreview.tsx +++ b/app/components/HoverPreview/HoverPreview.tsx @@ -21,9 +21,9 @@ const DELAY_OPEN = 500; const DELAY_CLOSE = 600; type Props = { - /* The HTML element that is being hovered over */ + /** The HTML element that is being hovered over */ element: HTMLAnchorElement; - /* A callback on close of the hover preview */ + /** A callback on close of the hover preview */ onClose: () => void; }; diff --git a/app/components/Icons/EmojiIcon.tsx b/app/components/Icons/EmojiIcon.tsx index f7b535baf..d4ce0e61f 100644 --- a/app/components/Icons/EmojiIcon.tsx +++ b/app/components/Icons/EmojiIcon.tsx @@ -2,9 +2,9 @@ import * as React from "react"; import styled from "styled-components"; type Props = { - /* The emoji to render */ + /** The emoji to render */ emoji: string; - /* The size of the emoji, 24px is default to match standard icons */ + /** The size of the emoji, 24px is default to match standard icons */ size?: number; }; diff --git a/app/components/Icons/OutlineIcon.tsx b/app/components/Icons/OutlineIcon.tsx index 05fa32927..bb7f29ce7 100644 --- a/app/components/Icons/OutlineIcon.tsx +++ b/app/components/Icons/OutlineIcon.tsx @@ -5,7 +5,7 @@ type Props = { size?: number; /** The color of the icon, defaults to the current text color */ color?: string; - /* Whether the safe area should be removed and have graphic across full size */ + /** Whether the safe area should be removed and have graphic across full size */ cover?: boolean; }; diff --git a/app/components/Input.tsx b/app/components/Input.tsx index 251d0830e..14272da3a 100644 --- a/app/components/Input.tsx +++ b/app/components/Input.tsx @@ -121,7 +121,7 @@ export type Props = React.InputHTMLAttributes< margin?: string | number; error?: string; icon?: React.ReactNode; - /* Callback is triggered with the CMD+Enter keyboard combo */ + /** Callback is triggered with the CMD+Enter keyboard combo */ onRequestSubmit?: ( ev: React.KeyboardEvent ) => unknown; diff --git a/app/components/Key.ts b/app/components/Key.ts index 5cbc6d6a8..1854a9f76 100644 --- a/app/components/Key.ts +++ b/app/components/Key.ts @@ -1,7 +1,7 @@ import styled from "styled-components"; type Props = { - /* Set to true if displaying a single symbol character to disable monospace */ + /** Set to true if displaying a single symbol character to disable monospace */ symbol?: boolean; }; diff --git a/app/components/Notifications/Notifications.tsx b/app/components/Notifications/Notifications.tsx index ce0681c58..723a34d83 100644 --- a/app/components/Notifications/Notifications.tsx +++ b/app/components/Notifications/Notifications.tsx @@ -22,7 +22,7 @@ import Tooltip from "../Tooltip"; import NotificationListItem from "./NotificationListItem"; type Props = { - /* Callback when the notification panel wants to close. */ + /** Callback when the notification panel wants to close. */ onRequestClose: () => void; }; diff --git a/app/components/Sidebar/components/SidebarLink.tsx b/app/components/Sidebar/components/SidebarLink.tsx index 48ac4a106..cbf2cd1a5 100644 --- a/app/components/Sidebar/components/SidebarLink.tsx +++ b/app/components/Sidebar/components/SidebarLink.tsx @@ -22,7 +22,7 @@ type Props = Omit & { to?: LocationDescriptor; innerRef?: (ref: HTMLElement | null | undefined) => void; onClick?: React.MouseEventHandler; - /* Callback when we expect the user to click on the link. Used for prefetching data. */ + /** Callback when we expect the user to click on the link. Used for prefetching data. */ onClickIntent?: () => void; onDisclosureClick?: React.MouseEventHandler; icon?: React.ReactNode; @@ -32,7 +32,7 @@ type Props = Omit & { showActions?: boolean; disabled?: boolean; active?: boolean; - /* If set, a disclosure will be rendered to the left of any icon */ + /** If set, a disclosure will be rendered to the left of any icon */ expanded?: boolean; isActiveDrop?: boolean; isDraft?: boolean; diff --git a/server/middlewares/authentication.ts b/server/middlewares/authentication.ts index 278d89008..8943cd112 100644 --- a/server/middlewares/authentication.ts +++ b/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 diff --git a/server/queues/tasks/CleanupExpiredFileOperationsTask.test.ts b/server/queues/tasks/CleanupExpiredFileOperationsTask.test.ts index 1af1608c6..00b2a17d3 100644 --- a/server/queues/tasks/CleanupExpiredFileOperationsTask.test.ts +++ b/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 }); diff --git a/server/queues/tasks/ErrorTimedOutFileOperationsTask.test.ts b/server/queues/tasks/ErrorTimedOutFileOperationsTask.test.ts index caf55e17a..e70667692 100644 --- a/server/queues/tasks/ErrorTimedOutFileOperationsTask.test.ts +++ b/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 }); diff --git a/server/queues/tasks/UploadTeamAvatarTask.ts b/server/queues/tasks/UploadTeamAvatarTask.ts index 3301f4f9a..26f5c0c42 100644 --- a/server/queues/tasks/UploadTeamAvatarTask.ts +++ b/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; }; diff --git a/server/queues/tasks/UploadUserAvatarTask.ts b/server/queues/tasks/UploadUserAvatarTask.ts index 541ca1c38..e64356134 100644 --- a/server/queues/tasks/UploadUserAvatarTask.ts +++ b/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; }; diff --git a/server/types.ts b/server/types.ts index 884c2413f..b73170c2f 100644 --- a/server/types.ts +++ b/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; }; diff --git a/server/utils/azure.ts b/server/utils/azure.ts index 69350d20f..07c5ce9e5 100644 --- a/server/utils/azure.ts +++ b/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; };