From dc0237e3de8c88a0daae1b0f0caf677dfb63be66 Mon Sep 17 00:00:00 2001
From: braks <78412429+bcakmakoglu@users.noreply.github.com>
Date: Thu, 22 Sep 2022 10:01:00 +0200
Subject: [PATCH] chore(nc-gui): middleware comments

---
 packages/nc-gui/middleware/auth.global.ts | 14 +++++---------
 1 file changed, 5 insertions(+), 9 deletions(-)

diff --git a/packages/nc-gui/middleware/auth.global.ts b/packages/nc-gui/middleware/auth.global.ts
index 81d147fcea..cec4d83a54 100644
--- a/packages/nc-gui/middleware/auth.global.ts
+++ b/packages/nc-gui/middleware/auth.global.ts
@@ -11,7 +11,9 @@ import { useApi, useGlobal, useRoles } from '#imports'
  * the user is redirected to the home page.
  *
  * By default, we assume that auth is required
- * If not required, mark the page as
+ * If not required, mark the page as requiresAuth: false
+ *
+ * @example
  * ```
  * definePageMeta({
  *   requiresAuth: false
@@ -19,18 +21,12 @@ import { useApi, useGlobal, useRoles } from '#imports'
  * ```
  *
  * If auth should be circumvented completely mark the page as public
- * ```
- * definePageMeta({
- *   public: true
- * })
- * ```
  *
  * @example
  * ```
  * definePageMeta({
- *  requiresAuth: false,
- *  ...
- *  })
+ *   public: true
+ * })
  * ```
  */
 export default defineNuxtRouteMiddleware(async (to, from) => {