Skip to content

Commit

Permalink
chore(docs): update function parameter comments (#4215)
Browse files Browse the repository at this point in the history
* docs(other): update function parameters jsdoc

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

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

在路线文档中,移除了`activePath`属性的默认值注释,以清晰说明其行为。此更改更新了文档内容,使其更准确地反映代码实现。
  • Loading branch information
fzq1998 authored Aug 22, 2024
1 parent e2732f3 commit d5655f0
Show file tree
Hide file tree
Showing 4 changed files with 2 additions and 2 deletions.
1 change: 0 additions & 1 deletion docs/src/guide/essentials/route.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,6 @@ interface RouteMeta {
activeIcon?: string;
/**
* 当前激活的菜单,有时候不想激活现有菜单,需要激活父级菜单时使用
* @default false
*/
activePath?: string;
/**
Expand Down
1 change: 0 additions & 1 deletion packages/@core/base/typings/src/vue-router.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ interface RouteMeta {
activeIcon?: string;
/**
* 当前激活的菜单,有时候不想激活现有菜单,需要激活父级菜单时使用
* @default false
*/
activePath?: string;
/**
Expand Down
1 change: 1 addition & 0 deletions packages/effects/access/src/accessible.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ async function generateAccessible(
/**
* Generate routes
* @param mode
* @param options
*/
async function generateRoutes(
mode: AccessModeType,
Expand Down
1 change: 1 addition & 0 deletions playground/src/store/auth.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ export const useAuthStore = defineStore('auth', () => {
* 异步处理登录操作
* Asynchronously handle the login process
* @param params 登录表单数据
* @param onSuccess 成功之后的回调函数
*/
async function authLogin(
params: LoginAndRegisterParams,
Expand Down

0 comments on commit d5655f0

Please sign in to comment.