From d82f3f587f61107356d517068b98e5a4dc5c0888 Mon Sep 17 00:00:00 2001
From: "humphry.hy" <humphry.hy@alibaba-inc.com>
Date: Tue, 14 Dec 2021 14:53:27 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E8=A1=A5=E5=AE=8C=20ts=20=E7=B1=BB?=
 =?UTF-8?q?=E5=9E=8B=E5=AE=9A=E4=B9=89?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 packages/types/src/assets.ts        |  4 +++-
 packages/types/src/field-config.ts  |  4 ++--
 packages/types/src/metadata.ts      | 12 +++++++-----
 packages/types/src/prop-config.ts   |  2 +-
 packages/types/src/schema.ts        |  7 ++-----
 packages/types/src/setter-config.ts |  1 -
 packages/types/src/title.ts         | 18 ++++++++++++++++++
 7 files changed, 33 insertions(+), 15 deletions(-)

diff --git a/packages/types/src/assets.ts b/packages/types/src/assets.ts
index e6f326513..b3420ee27 100644
--- a/packages/types/src/assets.ts
+++ b/packages/types/src/assets.ts
@@ -27,7 +27,9 @@ export interface Package {
    */
   library: string;
   /**
-   * @todo 待补充文档 @jinchan
+   * @deprecated
+   *
+   * @todo 需推进提案 @度城
    */
   async?: boolean;
   /**
diff --git a/packages/types/src/field-config.ts b/packages/types/src/field-config.ts
index f8e47fa19..70a881fde 100644
--- a/packages/types/src/field-config.ts
+++ b/packages/types/src/field-config.ts
@@ -96,11 +96,11 @@ export interface FieldConfig extends FieldExtraProps {
    */
   extraProps?: FieldExtraProps;
   /**
-   * @todo 待补充文档
+   * @deprecated
    */
   description?: TitleContent;
   /**
-   * @todo 待补充文档
+   * @deprecated
    */
   isExtends?: boolean;
 }
diff --git a/packages/types/src/metadata.ts b/packages/types/src/metadata.ts
index e8fef4cf6..c6b5559a8 100644
--- a/packages/types/src/metadata.ts
+++ b/packages/types/src/metadata.ts
@@ -101,11 +101,13 @@ export interface Snippet {
    */
   screenshot?: string;
   /**
-   * @todo snippet 打标
+   * snippet 打标
+   *
+   * @deprecated 暂未使用
    */
   label?: string;
   /**
-   * @todo 待补充文档
+   * 待插入的 schema
    */
   schema?: NodeSchema;
 }
@@ -132,7 +134,7 @@ export interface Experimental {
    */
   context?: { [contextInfoName: string]: any };
   /**
-   * @todo 待补充文档
+   * @deprecated 使用组件 metadata 上的 snippets 字段即可
    */
   snippets?: Snippet[];
   /**
@@ -160,7 +162,7 @@ export interface Experimental {
    */
   callbacks?: Callbacks;
   /**
-   * @todo 待补充文档
+   * 拖入容器时，自动带入 children 列表
    */
   initialChildren?: NodeData[] | ((target: SettingTarget) => NodeData[]);
   /**
@@ -201,7 +203,7 @@ export interface Experimental {
   liveTextEditing?: LiveTextEditingConfig[];
 
   /**
-   * @todo 待补充文档
+   * @deprecated 暂未使用
    */
   isTopFixed?: boolean;
 }
diff --git a/packages/types/src/prop-config.ts b/packages/types/src/prop-config.ts
index 5029ba2b3..502a23ce7 100644
--- a/packages/types/src/prop-config.ts
+++ b/packages/types/src/prop-config.ts
@@ -59,7 +59,7 @@ export interface PropConfig {
    */
   defaultValue?: any;
   /**
-   * @todo 待补充文档
+   * @deprecated 已被弃用
    */
   setter?: any;
 }
diff --git a/packages/types/src/schema.ts b/packages/types/src/schema.ts
index 10efdd9ef..2cfd1f7a9 100644
--- a/packages/types/src/schema.ts
+++ b/packages/types/src/schema.ts
@@ -168,6 +168,7 @@ export interface SlotSchema extends NodeSchema {
  * 应用描述
  */
 export interface ProjectSchema {
+  id?: string;
   /**
    * 当前应用协议版本号
    */
@@ -191,7 +192,7 @@ export interface ProjectSchema {
    */
   utils?: UtilsMap;
   /**
-   * @todo 待文档定义
+   * 应用范围内的全局常量
    */
   constants?: JSONObject;
   /**
@@ -206,10 +207,6 @@ export interface ProjectSchema {
    * 当前应用配置信息
    */
   config?: AppConfig | Record<string, any>;
-  /**
-   * @todo 待补充文档
-   */
-  id?: string;
   /**
    * 当前应用元数据信息
    */
diff --git a/packages/types/src/setter-config.ts b/packages/types/src/setter-config.ts
index 75088ed62..060bff991 100644
--- a/packages/types/src/setter-config.ts
+++ b/packages/types/src/setter-config.ts
@@ -18,7 +18,6 @@ export type DynamicSetter = (target: SettingTarget) => string | SetterConfig | C
 
 /**
  * 设置器配置
- * @todo
  */
 export interface SetterConfig {
   // if *string* passed must be a registered Setter Name
diff --git a/packages/types/src/title.ts b/packages/types/src/title.ts
index bdb641503..a4ac36614 100644
--- a/packages/types/src/title.ts
+++ b/packages/types/src/title.ts
@@ -3,11 +3,29 @@ import { I18nData, isI18nData } from './i18n';
 import { TipContent } from './tip';
 import { IconType } from './icon';
 
+/**
+ * 描述 props 的 setter title
+ */
 export interface TitleConfig {
+  /**
+   * 文字描述
+   */
   label?: I18nData | ReactNode;
+  /**
+   * hover 后的展现内容
+   */
   tip?: TipContent;
+  /**
+   * 文档链接，暂未实现
+   */
   docUrl?: string;
+  /**
+   * 图标
+   */
   icon?: IconType;
+  /**
+   * CSS 类
+   */
   className?: string;
 }