diff --git a/docs/develop.md b/docs/develop.md index 1bd8546afe4026d3667da823a1cf7e64f649252a..df982e13937d6e53bd03717a557671fdf2a47d4f 100644 --- a/docs/develop.md +++ b/docs/develop.md @@ -12,7 +12,7 @@ ### 架构图 -![架构图](..\figures\arch.png) +![架构图](https://gitee.com/openharmony/napi_generator/raw/master/figures/arch.png) ### 文件结构 @@ -45,23 +45,16 @@ napi_generator ##### 命令行生成工具介绍 * [cmake2gn](../src/cli/cmake2gn/docs/guide/DEVELOP_ZH.md) * [dts2cpp](../src/cli/dts2cpp/docs/guide/DEVELOP_ZH.md) -* [dts2ets](../src/cli/dts2ets/docs/guide/DEVELOP_ZH.md) * [h2dts](../src/cli/h2dts/docs/guide/DEVELOP_ZH.md) -* [h2dtscpp](../src/cli/h2dtscpp/docs/guide/DEVELOP_ZH.md) * [h2sa](../src/cli/h2sa/docs/guide/DEVELOP_ZH.md) ##### Intellij插件介绍 * [assist](../src/intellij_plugin/assist/assist_tools_IntelliJ_plugin/docs/guide/DEVELOP_ZH.md) -* [cmake2gn](../src/intellij_plugin/cmake2gn/gn_IntelliJ_plugin/docs/guide/DEVELOP_ZH.md) * [dts2cpp](../src/intellij_plugin/dts2cpp/napi_IntelliJ_plugin/docs/guide/DEVELOP_ZH.md) * [h2dts](../src/intellij_plugin/h2dts/ts_IntelliJ_plugin/docs/guide/DEVELOP_ZH.md) -* [h2dtscpp](../src/intellij_plugin/h2dtscpp/native_IntelliJ_plugin/docs/guide/DEVELOP_ZH.md) -* [h2sa](../src/intellij_plugin/h2sa/service_IntelliJ_plugin/docs/guide/DEVELOP_ZH.md) ##### API扫描工具介绍 * [api](../src/tool/api/api_scan_IntelliJ_plugin/docs/DEVELOP_ZH.md) ##### Vscode插件介绍 -* [assist](../src/vscode_plugin/assist/assist_tools_vs_plugin/docs/guide/DEVELOP_ZH.md) -* [cmake2gn](../src/vscode_plugin/cmake2gn/gn_vs_plugin/docs/guide/DEVELOP_ZH.md) -* [dts2cpp](../src/vscode_plugin/dts2cpp/napi_vs_plugin/docs/guide/DEVELOP_ZH.md) -* [h2dts](../src/vscode_plugin/h2dts/ts_vs_plugin/docs/guide/DEVELOP_ZH.md) -* [h2dtscpp](../src/vscode_plugin/h2dtscpp/native_vs_plugin/docs/guide/DEVELOP_ZH.md) -* [h2sa](../src/vscode_plugin/h2sa/service_vs_plugin/docs/guide/DEVELOP_ZH.md) +* [dts2cpp](../src/vscode_plugin/readme.md) +* [h2dts](../src/vscode_plugin/readme.md) +* [h2dtscpp](../src/vscode_plugin/readme.md) +* [h2sa](../src/vscode_plugin/readme.md) diff --git a/docs/readme.md b/docs/readme.md index 8c92f98b45ae9f318228887987342cad653fd76a..bde395097b833e26d43e8fd1ab1bef4f3c59513e 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -2,7 +2,7 @@ ## dts2cpp（NAPI框架代码生成工具） -[readme](https://gitee.com/openharmony/napi_generator/blob/master/src/cli/dts2cpp/dts2cpp_README_zh.md) +[readme](https://gitee.com/openharmony/napi_generator/blob/master/src/cli/dts2cpp/dts2cpp_README_ZH.md) ## h2dts（TS接口生成工具） @@ -14,7 +14,7 @@ ## h2sa（SERVICE框架生成工具） -[readme](https://gitee.com/openharmony/napi_generator/blob/master/src/cli/h2sa/h2sa_README_ZH.md) +[readme](https://gitee.com/openharmony/napi_generator/blob/master/src/cli/h2sa/README_ZH.md) ## h2dtscpp（NATIVE生成工具） diff --git a/docs/usage.md b/docs/usage.md index bcc59cd6705a1f3f6fd78da82b1f5ab3c8aa7a3a..b9982884153a13cf40819553221896ae1851159a 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -6,9 +6,7 @@ 可执行程序开发说明：[可执行程序开发说明](https://gitee.com/openharmony/napi_generator/blob/master/src/cli/dts2cpp/docs/guide/DEVELOP_ZH.md) -intelliJ插件开发说明：[intelliJ插件开发说明](https://gitee.com/openharmony/napi_generator/blob/master/src/intellij_plugin/dts2cpp/napi_IntelliJ_plugin/docs/guide/DEVELOP_zh.md) - -vscode插件开发说明：[vscode插件开发说明](https://gitee.com/openharmony/napi_generator/blob/master/src/vscode_plugin/dts2cpp/napi_vs_plugin/docs/guide/DEVELOP_ZH.md) +intelliJ插件开发说明：[intelliJ插件开发说明](https://gitee.com/openharmony/napi_generator/blob/master/src/intellij_plugin/dts2cpp/napi_IntelliJ_plugin/docs/guide/DEVELOP_ZH.md) **使用说明** @@ -16,7 +14,7 @@ vscode插件开发说明：[vscode插件开发说明](https://gitee.com/openharm intelliJ插件使用说明：[intelliJ插件使用说明](https://gitee.com/openharmony/napi_generator/blob/master/src/intellij_plugin/dts2cpp/napi_IntelliJ_plugin/docs/usage/INSTRUCTION_ZH.md) -vscode插件使用说明：[vscode插件使用说明](https://gitee.com/openharmony/napi_generator/blob/master/src/vscode_plugin/dts2cpp/napi_vs_plugin/docs/usage/INSTRUCTION_ZH.md) +vscode插件使用说明：[vscode插件使用说明](https://gitee.com/openharmony/napi_generator/blob/master/src/vscode_plugin/readme.md) ## h2dts（TS接口生成工具） @@ -24,17 +22,11 @@ vscode插件使用说明：[vscode插件使用说明](https://gitee.com/openharm 可执行程序开发说明：[可执行程序开发说明](https://gitee.com/openharmony/napi_generator/blob/master/src/cli/h2dts/docs/guide/DEVELOP_ZH.md) -intelliJ插件开发说明：[intelliJ插件开发说明](https://gitee.com/openharmony/napi_generator/blob/master/src/intellij_plugin/h2dts/ts_IntelliJ_plugin/docs/guide/DEVELOP_zh.md) - -vscode插件开发说明：[vscode插件开发说明](https://gitee.com/openharmony/napi_generator/blob/master/src/vscode_plugin/h2dts/ts_vs_plugin/docs/guide/DEVELOP_zh.md) - **使用说明** 可执行程序使用说明：[可执行程序使用说明](https://gitee.com/openharmony/napi_generator/blob/master/src/cli/h2dts/docs/usage/INSTRUCTION_ZH.md) -intelliJ插件使用说明：[intelliJ插件使用说明](https://gitee.com/openharmony/napi_generator/blob/master/src/intellij_plugin/h2dts/ts_IntelliJ_plugin/docs/usage/INSTRUCTION_ZH.md) - -vscode插件使用说明：[vscode插件使用说明](https://gitee.com/openharmony/napi_generator/blob/master/src/vscode_plugin/h2dts/ts_vs_plugin/docs/usage/INSTRUCTION_ZH.md) +vscode插件使用说明：[vscode插件使用说明](https://gitee.com/openharmony/napi_generator/blob/master/src/vscode_plugin/readme.md) ## h2sa（SERVICE框架生成工具） @@ -42,13 +34,11 @@ vscode插件使用说明：[vscode插件使用说明](https://gitee.com/openharm 可执行程序开发说明：[可执行程序开发说明](https://gitee.com/openharmony/napi_generator/blob/master/src/cli/h2sa/docs/guide/DEVELOP_ZH.md) -vscode插件开发说明：暂无 - **使用说明** 可执行程序使用说明：[可执行程序使用说明](https://gitee.com/openharmony/napi_generator/blob/master/src/cli/h2sa/docs/usage/h2sa_INSTRUCTION_ZH.md) -vscode插件使用说明：[vscode插件使用说明](https://gitee.com/openharmony/napi_generator/blob/master/src/vscode_plugin/h2sa/service_vs_plugin/docs/usage/INSTRUCTION_ZH.md) +vscode插件使用说明：[vscode插件使用说明](https://gitee.com/openharmony/napi_generator/blob/master/src/vscode_plugin/readme.md) ## cmake2gn（GN脚本生成工具） @@ -56,24 +46,18 @@ vscode插件使用说明：[vscode插件使用说明](https://gitee.com/openharm 可执行程序开发说明：[可执行程序开发说明](https://gitee.com/openharmony/napi_generator/blob/master/src/cli/cmake2gn/docs/guide/DEVELOP_ZH.md) -vscode插件开发说明：[vscode插件开发说明](https://gitee.com/openharmony/napi_generator/blob/master/src/vscode_plugin/cmake2gn/gn_vs_plugin/docs/guide/DEVELOP_zh.md) - **使用说明** 可执行程序使用说明：[可执行程序使用说明](https://gitee.com/openharmony/napi_generator/blob/master/src/cli/cmake2gn/docs/usage/INSTRUCTION_ZH.md) -vscode插件使用说明：[vscode插件使用说明](https://gitee.com/openharmony/napi_generator/blob/master/src/vscode_plugin/cmake2gn/gn_vs_plugin/docs/usage/INSTRUCTION_ZH.md) - ## h2dtscpp（NATIVE生成工具） -**开发说明** - -可执行程序开发说明：[可执行程序开发说明](https://gitee.com/openharmony/napi_generator/blob/master/src/cli/h2dtscpp/docs/guide/DEVELOP_ZH.md) - **使用说明** 可执行程序使用说明：[可执行程序使用说明](https://gitee.com/openharmony/napi_generator/blob/master/src/cli/h2dtscpp/docs/usage/INSTRUCTION_ZH.md) +vscode插件使用说明：[vscode插件使用说明](https://gitee.com/openharmony/napi_generator/blob/master/src/vscode_plugin/readme.md) + ## scan（API扫描工具） **开发说明** diff --git a/src/cli/cmake2gn/docs/guide/DEVELOP_ZH.md b/src/cli/cmake2gn/docs/guide/DEVELOP_ZH.md index 01e69910b2bc9a722d2c26ac9eedee0ee798c091..bab3fd62688b865cc65c1e29da82e18fdc8eb842 100644 --- a/src/cli/cmake2gn/docs/guide/DEVELOP_ZH.md +++ b/src/cli/cmake2gn/docs/guide/DEVELOP_ZH.md @@ -91,9 +91,3 @@ pkg -t node14-macos . -o gn-gen-macos -### VS插件开发说明 - -具体的插件开发步骤，可以左键单击以下链接了解： - -[VS插件开发说明](https://gitee.com/openharmony/napi_generator/blob/master/src/vscode_plugin/cmake2gn/gn_vs_plugin/docs/guide/DEVELOP_ZH.md) - diff --git a/src/cli/cmake2gn/docs/usage/ENSEMBLE_METHOD_ZH.md b/src/cli/cmake2gn/docs/usage/ENSEMBLE_METHOD_ZH.md index 1dd71fefec9afeb3ad96351cdabb108ae7b9946e..bf073c373daf9ed03fbb8996b8c6a5e7cc07e31a 100644 --- a/src/cli/cmake2gn/docs/usage/ENSEMBLE_METHOD_ZH.md +++ b/src/cli/cmake2gn/docs/usage/ENSEMBLE_METHOD_ZH.md @@ -62,11 +62,11 @@ harmony@Ubuntu-64:~$ cd /home/harmony/OpenHarmony/foundation/multimodalinput/inp ninja -C out/khdvk_rk3568_a all_targets ``` -![](./../figures/ninja_build_success.png) +![](https://gitee.com/openharmony/napi_generator/raw/master/src/cli/cmake2gn/docs/figures/ninja_build_success.png) 3、编译成功后，会生成mbedtls-development相关动态库文件或可执行程序，生成文件及路径如下所示： -![](./../figures/generate_file.png) +![](https://gitee.com/openharmony/napi_generator/raw/master/src/cli/cmake2gn/docs/figures/generate_file.png) ## 总结 diff --git a/src/cli/dts2cpp/docs/guide/DEVELOP_ZH.md b/src/cli/dts2cpp/docs/guide/DEVELOP_ZH.md index 089aa33e43256727d0361e38d4a69cc8eee8334f..ed2d3044b0bcccd56d4e5285bfe104c0b41e95dd 100644 --- a/src/cli/dts2cpp/docs/guide/DEVELOP_ZH.md +++ b/src/cli/dts2cpp/docs/guide/DEVELOP_ZH.md @@ -99,12 +99,6 @@ pkg -t node14-macos . -o napi_generator-macos -### VS插件开发说明 - -具体的插件开发步骤，可以左键单击以下链接了解： - -[VS插件开发说明](https://gitee.com/openharmony/napi_generator/blob/master/src/vscode_plugin/dts2cpp/napi_vs_plugin/docs/guide/DEVELOP_ZH.md) - ### DevEco Studio上使用的IntelliJ插件开发说明 具体的插件开发步骤，可以左键单击以下链接了解： diff --git a/src/cli/h2dtscpp/README.md b/src/cli/h2dtscpp/README.md index 1c6bcba5e07959d87bdb2666daa4c48ca95d1d33..90e4a04fb928cfcc621b1d1f00954ee9c27bbcc7 100644 --- a/src/cli/h2dtscpp/README.md +++ b/src/cli/h2dtscpp/README.md @@ -65,10 +65,6 @@ cppout文件夹下内容（部分文件截图）如下所示： ![](./docs/figures/h2dtscpp_cppout_example.png) -## 工具开发说明 - -[工具使用说明](https://gitee.com/openharmony/napi_generator/tree/master/src/cli/h2dtscpp/docs/guide/DEVELOP_ZH.md) - ## 版本说明 暂无 diff --git a/src/cli/h2sa/docs/usage/INSTRUCTION_ZH.md b/src/cli/h2sa/docs/usage/INSTRUCTION_ZH.md index a7a99c64c77dcccb75bc200ba9a448288bc6d048..ba8c3ab8308443d90aa8e8c6f0241490a69c325e 100644 --- a/src/cli/h2sa/docs/usage/INSTRUCTION_ZH.md +++ b/src/cli/h2sa/docs/usage/INSTRUCTION_ZH.md @@ -15,7 +15,7 @@ SERVICE框架生成工具支持一种入口，即VS Code插件，使用者可以 具体的插件使用步骤，可以左键单击以下链接了解： -[VS插件使用说明](https://gitee.com/openharmony/napi_generator/tree/master/src/vscode_plugin/h2sa/service_vs_plugin/docs/usage/INSTRUCTION_ZH.md) +[VS插件使用说明](https://gitee.com/openharmony/napi_generator/tree/master/src/vscode_plugin/readme.md) ## 集成 diff --git a/src/tool/api/docs/scan_INSTRUCTION_ZH.md b/src/tool/api/docs/scan_INSTRUCTION_ZH.md index 35bd79a5a0785f774aa84f9af28d45717ec2206a..3a4ceb17d59b414179511a59af323b1f21b7f626 100644 --- a/src/tool/api/docs/scan_INSTRUCTION_ZH.md +++ b/src/tool/api/docs/scan_INSTRUCTION_ZH.md @@ -7,7 +7,7 @@ scan工具，即API扫描工具，支持两种入口，分别是可执行程序 通过API扫描工具，开发者可以扫描输出三方库中存在，而OpenHarmony源码中不存在的风险接口，移植之前预知风险，降低移植难度，提高开发效率。 -![](./../figures/pic-api-frm.png) +![](https://gitee.com/openharmony/napi_generator/raw/master/src/tool/api/figures/pic-api-frm.png) ## 生成result文件