Added doc comment to alert()

packages/frontend/src/os.ts

@@ -266,6 +266,15 @@ export function toast(message: string) {
 	});
 }
 
+/**
+ * Displays an alert dialog to the user.
+ *
+ * @param {Object} props - The properties for the alert dialog.
+ * @param {'error' | 'info' | 'success' | 'warning' | 'waiting' | 'question'} [props.type] - The type of the alert.
+ * @param {string} [props.title] - The title of the alert dialog.
+ * @param {string} [props.text] - The text content of the alert dialog.
+ * @returns {Promise<void>} A promise that resolves when the alert dialog is closed.
+ */
 export function alert(props: {
 	type?: 'error' | 'info' | 'success' | 'warning' | 'waiting' | 'question';
 	title?: string;