diff options
author | Juan Linietsky <reduzio@gmail.com> | 2017-09-12 17:42:36 -0300 |
---|---|---|
committer | Juan Linietsky <reduzio@gmail.com> | 2017-09-12 17:45:41 -0300 |
commit | 4f929a0fdfae24b1ca5acf0b732219119090ee43 (patch) | |
tree | 730471182cae00f2e47c7430db441d057383d29b /modules | |
parent | 175777596ec3521731665dd750fd7087793b10fc (diff) |
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will
recognize them.
Diffstat (limited to 'modules')
-rw-r--r-- | modules/gridmap/config.py | 6 | ||||
-rw-r--r-- | modules/gridmap/doc_classes/GridMap.xml | 175 | ||||
-rw-r--r-- | modules/gridmap/doc_classes/README.md | 1 |
3 files changed, 182 insertions, 0 deletions
diff --git a/modules/gridmap/config.py b/modules/gridmap/config.py index 5698a37295..b3dbb9f46a 100644 --- a/modules/gridmap/config.py +++ b/modules/gridmap/config.py @@ -6,3 +6,9 @@ def can_build(platform): def configure(env): pass + +def get_doc_classes(): + return ["GridMap"] + +def get_doc_path(): + return "doc_classes" diff --git a/modules/gridmap/doc_classes/GridMap.xml b/modules/gridmap/doc_classes/GridMap.xml new file mode 100644 index 0000000000..3676570ec1 --- /dev/null +++ b/modules/gridmap/doc_classes/GridMap.xml @@ -0,0 +1,175 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="GridMap" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="clear"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_cell_item" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="x" type="int"> + </argument> + <argument index="1" name="y" type="int"> + </argument> + <argument index="2" name="z" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_cell_item_orientation" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="x" type="int"> + </argument> + <argument index="1" name="y" type="int"> + </argument> + <argument index="2" name="z" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_cell_size" qualifiers="const"> + <return type="Vector3"> + </return> + <description> + </description> + </method> + <method name="get_center_x" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_center_y" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_center_z" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="get_meshes"> + <return type="Array"> + </return> + <description> + </description> + </method> + <method name="get_octant_size" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_theme" qualifiers="const"> + <return type="MeshLibrary"> + </return> + <description> + </description> + </method> + <method name="resource_changed"> + <return type="void"> + </return> + <argument index="0" name="resource" type="Resource"> + </argument> + <description> + </description> + </method> + <method name="set_cell_item"> + <return type="void"> + </return> + <argument index="0" name="x" type="int"> + </argument> + <argument index="1" name="y" type="int"> + </argument> + <argument index="2" name="z" type="int"> + </argument> + <argument index="3" name="item" type="int"> + </argument> + <argument index="4" name="orientation" type="int" default="0"> + </argument> + <description> + </description> + </method> + <method name="set_cell_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="Vector3"> + </argument> + <description> + </description> + </method> + <method name="set_center_x"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_center_y"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_center_z"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_clip"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <argument index="1" name="clipabove" type="bool" default="true"> + </argument> + <argument index="2" name="floor" type="int" default="0"> + </argument> + <argument index="3" name="axis" type="int" enum="Vector3.Axis" default="0"> + </argument> + <description> + </description> + </method> + <method name="set_octant_size"> + <return type="void"> + </return> + <argument index="0" name="size" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_theme"> + <return type="void"> + </return> + <argument index="0" name="theme" type="MeshLibrary"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="INVALID_CELL_ITEM" value="-1" enum=""> + </constant> + </constants> +</class> diff --git a/modules/gridmap/doc_classes/README.md b/modules/gridmap/doc_classes/README.md new file mode 100644 index 0000000000..b1ec9058c8 --- /dev/null +++ b/modules/gridmap/doc_classes/README.md @@ -0,0 +1 @@ +Doc classes will appear here when generating
\ No newline at end of file |