awtk/tools/idl_gen
2019-09-30 17:28:18 +08:00
..
.vscode rework idl gen 2018-08-05 11:49:47 +08:00
.gitignore init 2018-02-21 19:36:38 +08:00
idl.json update docs 2019-09-30 17:28:18 +08:00
index.js improve tools 2019-05-08 15:42:13 +08:00
merge.js add merge.js and update docs 2019-05-08 16:23:46 +08:00
README.md add merge.js and update docs 2019-05-08 16:23:46 +08:00

AWTK IDL 生成工具

在 AWTK 中,对外的 API 都按 规定格式 编写注释,通过 IDL gen 工具把这些注释提取成 JSON 文件,这个 JSON 文件可以用来生成文档、各种语言的绑定和 web 版本对外的 API。

一、准备工作

(如果已经安装请跳过)

二、生成 IDL 文件

    1. 基本用法
node index.js  [输出的 IDL 文件名] [源代码路径]
    1. 生成 AWTK 的 IDL 文件。
node index.js
    1. 生成外部项目的 IDL 文件。

生成外部项目的 IDL 文件时,需要指定输出的 IDL 文件名源代码的路径。如:

node index.js  slider_circle.idl ../../../awtk_slider_circle/src

三、合并多个 IDL 文件

生成各种语言绑定时,需要把 AWTK 本身的 IDL、自定义控件的 IDL、和其它类的 IDL 合并到一个 IDL 文件中,这时可以使用 merge.js 工具。

基本用法:

node merge.js [多个 IDL 文件(被依赖的放在前面)]

如:

node merge.js idl.json test.json