@jlceda/pro-api-types 0.1.109 → 0.1.110

package/index.d.ts

@@ -3569,7 +3569,7 @@ declare class IPCB_PrimitiveFill implements IPCB_Primitive {
      */
     convertToPour(): Promise<IPCB_PrimitivePour>;
     /**
-     * 转换到：区域图元(默认是禁止区域)
+     * 转换到：区��图元(默认是禁止区域)
      *
      * @beta
      * @returns 区域图元对象
@@ -5858,7 +5858,7 @@ declare class ISCH_PrimitiveComponent implements ISCH_Primitive {
      */
     getState_ComponentType(): ESCH_PrimitiveComponentType;
     /**
-     * 获取属性状态：图元 ID
+     * 获取属性状态：���元 ID
      *
      * @public
      * @returns 图元 ID
@@ -7124,7 +7124,16 @@ declare class LIB_Footprint {
      * @returns 操作是否成功
      */
     modify(footprintUuid: string, libraryUuid: string, footprintName?: string, classification?: ILIB_ClassificationIndex | null, description?: string | null): Promise<boolean>;
-    /* Excluded from this release type: updateDocumentSource */
+    /**
+     * 更新封装的文档源码
+     *
+     * @beta
+     * @param footprintUuid - 封装 UUID
+     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
+     * @param documentSource - 文档源码
+     * @returns 是否更新成功
+     */
+    updateDocumentSource(footprintUuid: string, libraryUuid: string, documentSource: string): Promise<boolean | undefined>;
     /**
      * 获取封装的所有属性
      *
@@ -7174,7 +7183,7 @@ declare class LIB_Footprint {
  * 综合库 / 库列表类
  *
  * @public
- * @remarks 此处所有���口都基于编辑器当前工作区环境，如需切换到其他工作区，请使用 {@link DMT_Workspace.toggleToWorkspace} 接口切换工作区
+ * @remarks 此处所有接口都基于编辑器当前工作区环境，如需切换到其他工作区，请使用 {@link DMT_Workspace.toggleToWorkspace} 接口切换工作区
  */
 declare class LIB_LibrariesList {
     /**
@@ -7342,7 +7351,16 @@ declare class LIB_Symbol {
      * @returns 操作是否成功
      */
     modify(symbolUuid: string, libraryUuid: string, symbolName?: string, classification?: ILIB_ClassificationIndex | null, description?: string | null): Promise<boolean>;
-    /* Excluded from this release type: updateDocumentSource */
+    /**
+     * 更新符号的文档源码
+     *
+     * @beta
+     * @param symbolUuid - 符号 UUID
+     * @param libraryUuid - 库 UUID，可以使用 {@link LIB_LibrariesList} 内的接口获取
+     * @param documentSource - 文档源码
+     * @returns 是否更新成功
+     */
+    updateDocumentSource(symbolUuid: string, libraryUuid: string, documentSource: string): Promise<boolean | undefined>;
     /**
      * 获取符号的所有属性
      *
@@ -7365,7 +7383,7 @@ declare class LIB_Symbol {
      */
     copy(symbolUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex, newSymbolName?: string): Promise<string | undefined>;
     /**
-     * 搜索���号
+     * 搜索符号
      *
      * @beta
      * @param key - 搜索关键字
@@ -7568,7 +7586,7 @@ declare class PCB_Drc {
      * @public
      * @param strict - 是否严格检查，严格检查时存在 Warning 将返回 `false`，否则返回 `true`
      * @param userInterface - 是否显示 UI（呼出底部 DRC 窗口）
-     * @returns DRC ���查是否无错误
+     * @returns DRC 检查是否无错误
      */
     check(strict?: boolean, userInterface?: boolean): Promise<boolean>;
     /**
@@ -7668,7 +7686,7 @@ declare class PCB_Drc {
      * 覆写网络规则
      *
      * @beta
-     * @remarks 将会覆写当前 PCB 的所有网络规则，请注意数据丢失��险
+     * @remarks 将会覆写当前 PCB 的所有网络规则，请注意数据丢失风险
      * @param netRules - 网络规则
      * @returns 覆写是否成功
      */
@@ -9100,7 +9118,7 @@ declare class PCB_PrimitiveLine implements IPCB_PrimitiveAPI {
      * 获取直线
      *
      * @beta
-     * @remarks 如若��入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
+     * @remarks 如若传入多个图元 ID，任意图元 ID 未匹配到不影响其它图元的返回，即可能返回少于传入的图元 ID 数量的图元对象
      * @param primitiveIds - 直线的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 直线图元对象，空数组表示获取失败
      */
@@ -9183,7 +9201,7 @@ declare class PCB_PrimitiveObject implements IPCB_PrimitiveAPI {
      * 获取二进制内嵌对象
      *
      * @beta
-     * @param primitiveIds - 二进制内嵌对象的图元 ID，可以为字符串或字符串数组，如若为数组，则返回的也是数组
+     * @param primitiveIds - 二进制内嵌对象的图元 ID，��以为字符串或字符串数组，如若为数组，则返回的也是数组
      * @returns 二进制内嵌对象图元对象，`undefined` 表示获取失败
      */
     get(primitiveIds: string): Promise<IPCB_PrimitiveObject | undefined>;
@@ -10024,7 +10042,7 @@ declare class SCH_PrimitiveBus implements ISCH_PrimitiveAPI {
      *
      * @beta
      * @param busName - 总线名称
-     * @param line - 多段线坐标组，每段都是连续的��组 `[x1, y1, x2, y2, x3, y3]` 所描述的线，如若多段线彼此无任何连接则创建将会失败
+     * @param line - 多段线坐标组，每段都是连续的一组 `[x1, y1, x2, y2, x3, y3]` 所描述的线，如若多段线彼此无任何连接则创建将会失败
      * @param color - 总线颜色，`null` 表示默认
      * @param lineWidth - 线宽，范围 `1-10`，`null` 表示默认
      * @param lineType - 线型，`0` 实线，`1` 短划线，`2` 点线，`3` 点划线，`null` 表示默认
@@ -10978,7 +10996,7 @@ declare class SYS_FileManager {
      */
     getProjectFile(fileName?: string, password?: string): Promise<File | undefined>;
     /**
-     * 获取文档文件
+     * ���取文档文件
      *
      * @public
      * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
@@ -11690,7 +11708,7 @@ declare class SYS_Timer {
  */
 declare class SYS_ToastMessage {
     /**
-     * 显��吐司消息
+     * 显示吐司消息
      *
      * @public
      * @deprecated 请使用 {@link SYS_Message.showToastMessage} 方法替代

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@jlceda/pro-api-types",
-	"version": "0.1.109",
+	"version": "0.1.110",
 	"description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义",
 	"typings": "index.d.ts",
 	"keywords": [