diff --git a/src/components/switch-options.ts b/src/components/switch-options.ts index 6fbe163d0..467862734 100644 --- a/src/components/switch-options.ts +++ b/src/components/switch-options.ts @@ -2,10 +2,12 @@ * Switch Options API * @module src/components/switch-options * - * 通过包装原始的 ComponentMetadata 为组件提供一系列开关选项。 + * 通过包装原始的 {@link ComponentMetadata} 为组件提供一系列开关选项。 * 如果组件未定义 Widget,还会提供一个默认的有相同效果的 Widget。 * - * API 主要函数是 {@link newSwitchComponentWrapper}。 + * 包装器使用 {@link newSwitchComponentWrapper} 创建。 + * + * 可以通过 {@link SwitchOptionsOfMetadata} 或 {@link SwitchOptionsOfSwitchMetadata} 从包装器的设置中,获取被包装后的组件的 options 类型 */ import { getComponentSettings, addComponentListener } from '@/core/settings' @@ -39,14 +41,14 @@ export type SwitchItemsMetadata = { } /** - * 可用于单独定义 SwitchItemsMetadata + * 可用于单独定义 {@link SwitchItemsMetadata} */ export const defineSwitchItemsMetadata = ( c: SwitchItemsMetadata, ): SwitchItemsMetadata => c /** - * 用于配置 API 的行为。使用 {@link defineSwitchMetadata} 定义。 + * 用于配置 API 的行为。可以使用 {@link defineSwitchMetadata} 辅助定义。 */ export interface SwitchMetadata { /** @@ -82,7 +84,7 @@ export interface SwitchMetadata { } /** - * 定义一个 {@link SwitchMetadata} + * 辅助定义 {@link SwitchMetadata} */ export const defineSwitchMetadata = ( c: SwitchMetadata, @@ -113,7 +115,7 @@ export interface SwitchMetadataOption { } /** - * 创建一个 SwitchMetadataOption + * 创建一个 {@link SwitchMetadataOption} */ const newSwitchMetadataOption = ( metadata: SwitchMetadata, @@ -151,7 +153,7 @@ export type SwitchOptions /** - * 提取 SwitchOptions 类型 + * 提取 {@link SwitchOptions} 类型 */ export type SwitchOptionsOfSwitchMetadata< O extends UnknownOptions, @@ -159,7 +161,7 @@ export type SwitchOptionsOfSwitchMetadata< > = C extends SwitchMetadata ? SwitchOptions : never /** - * 提取 SwitchOptions 类型 + * 提取 {@link SwitchOptions} 类型 */ export type SwitchOptionsOfMetadata< M extends OptionsMetadata, @@ -288,9 +290,7 @@ export type SwitchComponentWrapper = (