From d5655f02e3253478e6692dba97ccf1bf073cca02 Mon Sep 17 00:00:00 2001
From: handsomeFu <fzq980219@gmail.com>
Date: Thu, 22 Aug 2024 21:52:44 +0800
Subject: [PATCH] chore(docs): update function parameter comments (#4215)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* docs(other): update function parameters jsdoc

- 移除`vue-router.d.ts`中`activePath`属性的默认值注释。
- 重构`generateRoutes`函数签名，增加`options`参数。
- 调整`authLogin`函数文档，增加`onSuccess`回调函数的说明。

* docs: 删除 `activePath` 属性的默认值注释

在路线文档中，移除了`activePath`属性的默认值注释，以清晰说明其行为。此更改更新了文档内容，使其更准确地反映代码实现。
---
 docs/src/guide/essentials/route.md              | 1 -
 packages/@core/base/typings/src/vue-router.d.ts | 1 -
 packages/effects/access/src/accessible.ts       | 1 +
 playground/src/store/auth.ts                    | 1 +
 4 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/src/guide/essentials/route.md b/docs/src/guide/essentials/route.md
index 29fa298b..51da3d72 100644
--- a/docs/src/guide/essentials/route.md
+++ b/docs/src/guide/essentials/route.md
@@ -293,7 +293,6 @@ interface RouteMeta {
   activeIcon?: string;
   /**
    * 当前激活的菜单，有时候不想激活现有菜单，需要激活父级菜单时使用
-   * @default false
    */
   activePath?: string;
   /**
diff --git a/packages/@core/base/typings/src/vue-router.d.ts b/packages/@core/base/typings/src/vue-router.d.ts
index ba6407d7..87349cd7 100644
--- a/packages/@core/base/typings/src/vue-router.d.ts
+++ b/packages/@core/base/typings/src/vue-router.d.ts
@@ -9,7 +9,6 @@ interface RouteMeta {
   activeIcon?: string;
   /**
    * 当前激活的菜单，有时候不想激活现有菜单，需要激活父级菜单时使用
-   * @default false
    */
   activePath?: string;
   /**
diff --git a/packages/effects/access/src/accessible.ts b/packages/effects/access/src/accessible.ts
index 289a3bd0..89f3a11c 100644
--- a/packages/effects/access/src/accessible.ts
+++ b/packages/effects/access/src/accessible.ts
@@ -36,6 +36,7 @@ async function generateAccessible(
 /**
  * Generate routes
  * @param mode
+ * @param options
  */
 async function generateRoutes(
   mode: AccessModeType,
diff --git a/playground/src/store/auth.ts b/playground/src/store/auth.ts
index c21d6b6d..5c50b150 100644
--- a/playground/src/store/auth.ts
+++ b/playground/src/store/auth.ts
@@ -24,6 +24,7 @@ export const useAuthStore = defineStore('auth', () => {
    * 异步处理登录操作
    * Asynchronously handle the login process
    * @param params 登录表单数据
+   * @param onSuccess 成功之后的回调函数
    */
   async function authLogin(
     params: LoginAndRegisterParams,