Skip to content

Commit

Permalink
再优化文档
Browse files Browse the repository at this point in the history
  • Loading branch information
@owent
owent committed Apr 18, 2019
1 parent 56356f1 commit 2827719
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 15 deletions.
36 changes: 25 additions & 11 deletions source/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,31 @@ xresloader文档
* 提供GUI批量转换工具（支持Windows、macOS、Linux）
* CLI/GUI批量转换工具支持include来实现配置复用

+----------------------------------------------+--------------------------------------------------------------------------------------+
| 构建环境 | Linux (Oracle JDK 8) |
+==============================================+======================================================================================+
| `xresloader`_ 当前构建状态 | .. image:: https://travis-ci.org/xresloader/xresloader.svg?branch=master |
| | :alt: Build Status |
| | :target: https://travis-ci.org/xresloader/xresloader |
+----------------------------------------------+--------------------------------------------------------------------------------------+
| 文档构建状态 | .. image:: https://readthedocs.org/projects/xresloader-docs/badge/?version=latest |
| | :alt: Documentation Status |
| | :target: https://readthedocs.org/projects/xresloader-docs/ |
+----------------------------------------------+--------------------------------------------------------------------------------------+
+--------------------+---------------------------------------------+
| 构建环境 | 构建状态 |
+====================+=============================================+
| `xresloader`_ | Linux (Oracle JDK 8): |xresloader-trivis| |
+--------------------+---------------------------------------------+
| `xresconv-cli`_ | 直接下载发布包即可，无需构建打包 |
+--------------------+---------------------------------------------+
| `xresconv-gui`_ | Windows: |xresconv-gui-appveyor| |
| | macOS&Linux: |xresconv-gui-trivis| |
+--------------------+---------------------------------------------+
| 文档 | |xresloader-docs| |
+--------------------+---------------------------------------------+

.. |xresloader-trivis| image:: https://travis-ci.org/xresloader/xresloader.svg?branch=master
:alt: Build Status
:target: https://travis-ci.org/xresloader/xresloader
.. |xresconv-gui-appveyor| image:: https://ci.appveyor.com/api/projects/status/jla48prtf6brkgnf?svg=true
:alt: Build Status
:target: https://ci.appveyor.com/project/owt5008137/xresconv-gui
.. |xresconv-gui-trivis| image:: https://api.travis-ci.org/xresloader/xresconv-gui.svg?branch=master
:alt: Build Status
:target: https://travis-ci.org/xresloader/xresconv-gui
.. |xresloader-docs| image:: https://readthedocs.org/projects/xresloader-docs/badge/?version=latest
:alt: Documentation Status
:target: https://readthedocs.org/projects/xresloader-docs/

.. _xresloader: https://github.com/xresloader
.. _xresloader-core: https://github.com/xresloader/xresloader
Expand Down
12 changes: 8 additions & 4 deletions source/users/advance_usage.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@

.. _xresloader: https://github.com/xresloader/xresloader
.. _xresloader sample: https://github.com/xresloader/xresloader/tree/master/sample
.. _xresloader sample proto_v3 kind.proto: https://github.com/xresloader/xresloader/tree/master/sample
.. _xresloader header extensions: https://github.com/xresloader/xresloader/tree/master/header/extensions
.. _xresloader header extensions v2: https://github.com/xresloader/xresloader/tree/master/header/extensions/v2
.. _xresloader header extensions v3: https://github.com/xresloader/xresloader/tree/master/header/extensions/v3

元数据替换（别名/宏）
---------------------------------------------
Expand Down Expand Up @@ -89,11 +93,11 @@
Protobuf 插件支持
---------------------------------------------

项目中可以导入 `xresloader header extensions`_ 目录， 然后通过导入 `xresloader header extensions v2`_ 或 `xresloader header extensions v3`_ 中的相应proto文件，就可以获得额外的插件扩展支持。

Protobuf插件 - Message插件
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

项目中可以导入 [header/extensions](header/extensions) 目录， 然后通过导入 [header/v2](header/extensions/v2) 或 [header/v2](header/extensions/v3) 中的相应proto文件来支持额外的插件扩展支持。

+--------------------------------+----------------------------------------------+
| 插件名称 | 插件功能 |
+================================+==============================================+
Expand All @@ -102,7 +106,7 @@ Protobuf插件 - Message插件
| org.xresloader.ue.helper | 生成UE Utility代码的类名后缀 |
+--------------------------------+----------------------------------------------+

比如 `xresloader sample`_ 里， ``proto_v3/kind.proto`` 内的 ``arr_in_arr_cfg`` 这一列配置了相关字段，会影响到一些输出。
比如 `xresloader sample proto_v3 kind.proto`_ 里， ``arr_in_arr_cfg`` 配置了相关字段，会影响到一些输出。

Protobuf插件 - Field插件
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -119,7 +123,7 @@ Protobuf插件 - Field插件
| org.xresloader.ue.ueTypeName | 生成UE代码时，如果指定了这个字段，那么生成的字段类型将是 ```TSoftObjectPtr<ueTypeName>``` , 并且支持蓝图中直接引用 |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------+

比如 `xresloader sample`_ 里， ``proto_v3/kind.proto`` 内的 ``role_upgrade_cfg.CostType`` 这一列配置验证器引射到协议的 ``cost_type`` 和 协议描述字段。
比如 `xresloader sample proto_v3 kind.proto`_ 里， ``role_upgrade_cfg`` 内的 ``CostType`` 这一列配置验证器引射到协议的 ``cost_type`` 和 协议描述字段。

仅导出部分字段
---------------------------------------------
Expand Down

0 comments on commit 2827719

Please sign in to comment.