Change comments in switch-options.ts

This commit is contained in:
timongh 2023-02-22 21:16:59 +08:00
parent 2e3f4e613b
commit b22d9ad8ff

View File

@ -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<S extends string> = {
}
/**
* SwitchItemsMetadata
* {@link SwitchItemsMetadata}
*/
export const defineSwitchItemsMetadata = <S extends string>(
c: SwitchItemsMetadata<S>,
): SwitchItemsMetadata<S> => c
/**
* API 使 {@link defineSwitchMetadata}
* API 使 {@link defineSwitchMetadata}
*/
export interface SwitchMetadata<N extends string, S extends string> {
/**
@ -82,7 +84,7 @@ export interface SwitchMetadata<N extends string, S extends string> {
}
/**
* {@link SwitchMetadata}
* {@link SwitchMetadata}
*/
export const defineSwitchMetadata = <N extends string, S extends string>(
c: SwitchMetadata<N, S>,
@ -113,7 +115,7 @@ export interface SwitchMetadataOption<N extends string, S extends string> {
}
/**
* SwitchMetadataOption
* {@link SwitchMetadataOption}
*/
const newSwitchMetadataOption = <N extends string, S extends string>(
metadata: SwitchMetadata<N, S>,
@ -151,7 +153,7 @@ export type SwitchOptions<O extends UnknownOptions, N extends string, S extends
} & SwitchItemOptions<S>
/**
* SwitchOptions
* {@link SwitchOptions}
*/
export type SwitchOptionsOfSwitchMetadata<
O extends UnknownOptions,
@ -159,7 +161,7 @@ export type SwitchOptionsOfSwitchMetadata<
> = C extends SwitchMetadata<infer N, infer S> ? SwitchOptions<O, N, S> : never
/**
* SwitchOptions
* {@link SwitchOptions}
*/
export type SwitchOptionsOfMetadata<
M extends OptionsMetadata,
@ -288,9 +290,7 @@ export type SwitchComponentWrapper<N extends string, S extends string> = <O exte
/**
* {@link SwitchComponentWrapper}
*
* 使 {@link defineSwitchMetadata}
*
* @param metadata -
* @param metadata - 使 {@link defineSwitchMetadata}
* @returns
*/
export const newSwitchComponentWrapper = <N extends string, S extends string>(