Browse Source

chore(docs): update function parameter comments (#4215)

* docs(other): update function parameters jsdoc

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

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

在路线文档中,移除了`activePath`属性的默认值注释,以清晰说明其行为。此更改更新了文档内容,使其更准确地反映代码实现。
pull/4223/head
handsomeFu 1 year ago
committed by GitHub
parent
commit
d5655f02e3
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 1
      docs/src/guide/essentials/route.md
  2. 1
      packages/@core/base/typings/src/vue-router.d.ts
  3. 1
      packages/effects/access/src/accessible.ts
  4. 1
      playground/src/store/auth.ts

1
docs/src/guide/essentials/route.md

@ -293,7 +293,6 @@ interface RouteMeta {
activeIcon?: string;
/**
* 当前激活的菜单,有时候不想激活现有菜单,需要激活父级菜单时使用
* @default false
*/
activePath?: string;
/**

1
packages/@core/base/typings/src/vue-router.d.ts

@ -9,7 +9,6 @@ interface RouteMeta {
activeIcon?: string;
/**
* 使
* @default false
*/
activePath?: string;
/**

1
packages/effects/access/src/accessible.ts

@ -36,6 +36,7 @@ async function generateAccessible(
/**
* Generate routes
* @param mode
* @param options
*/
async function generateRoutes(
mode: AccessModeType,

1
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,

Loading…
Cancel
Save