test/awtk
1
0
Fork 0
mirror of https://gitee.com/zlgopen/awtk.git synced 2024-11-30 11:08:34 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
7d96cde412
awtk/tools/doc_gen
History
lixianjing 34408cd6ce update docs
2019-09-30 02:15:38 -07:00
..
.gitignore add doc_gen 2018-12-12 17:58:47 +08:00
gen.sh improve tools 2019-05-08 15:42:13 +08:00
index.js update docs 2019-09-30 02:15:38 -07:00
plantuml.jar improve doc_gen 2018-12-13 17:20:07 +08:00
README.md improve tools 2019-05-08 15:42:13 +08:00
sync.sh improve tools 2019-05-08 15:42:13 +08:00

README.md

AWTK 文档生成工具

生成文档的流程：

    1. 在头文件中按 规定格式 编写注释。
    1. 利用工具 IDL gen 提取注释生成 IDL JSON 文件。
    1. 利用本工具把 IDL JSON 文件转换成 Markdown 文档。

一、准备工作

（如果已经安装请跳过）

二、生成文档

    1. 生成 AWTK 的文档。
./gen.sh
    1. 生成外部项目的文档
./gen.sh some_idl.json

这里的 some_idl.json 文件是用 IDL gen 提取注释生成的 IDL JSON 文件。

三、同步到docs/manual

生成的文档放在 docs 目录里，AWTK 的文档可以用 sync.sh 拷贝到手册目录。

./sync.sh

外部项目的文档请自行拷贝到自己的目录中。