summaryrefslogtreecommitdiffstats
path: root/modules/gridmap/doc_classes/GridMap.xml
diff options
context:
space:
mode:
authorYuri Sizov <yuris@humnom.net>2023-04-26 21:36:04 +0200
committerYuri Sizov <yuris@humnom.net>2023-04-26 21:36:04 +0200
commit391eccca76ace6863e20b6a579ed1550ed33dedb (patch)
tree6ce45b4b00b105331518ba6d29fc8498631091a1 /modules/gridmap/doc_classes/GridMap.xml
parente2e870c6118f6e9463c8907c947102f913f543de (diff)
downloadredot-engine-391eccca76ace6863e20b6a579ed1550ed33dedb.tar.gz
Validate code tags in documentation for potential params
Adds a check to make_rst to look for matches between the text inside of the [code][/code] tag and known param identifiers. Fixes most of what was revealed.
Diffstat (limited to 'modules/gridmap/doc_classes/GridMap.xml')
-rw-r--r--modules/gridmap/doc_classes/GridMap.xml10
1 files changed, 5 insertions, 5 deletions
diff --git a/modules/gridmap/doc_classes/GridMap.xml b/modules/gridmap/doc_classes/GridMap.xml
index 8e25d0fb84..e413560c16 100644
--- a/modules/gridmap/doc_classes/GridMap.xml
+++ b/modules/gridmap/doc_classes/GridMap.xml
@@ -73,14 +73,14 @@
<return type="bool" />
<param index="0" name="layer_number" type="int" />
<description>
- Returns whether or not the specified layer of the [member collision_layer] is enabled, given a [code]layer_number[/code] between 1 and 32.
+ Returns whether or not the specified layer of the [member collision_layer] is enabled, given a [param layer_number] between 1 and 32.
</description>
</method>
<method name="get_collision_mask_value" qualifiers="const">
<return type="bool" />
<param index="0" name="layer_number" type="int" />
<description>
- Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [code]layer_number[/code] between 1 and 32.
+ Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [param layer_number] between 1 and 32.
</description>
</method>
<method name="get_meshes" qualifiers="const">
@@ -113,7 +113,7 @@
<return type="Vector3i[]" />
<param index="0" name="item" type="int" />
<description>
- Returns an array of all cells with the given item index specified in [code]item[/code].
+ Returns an array of all cells with the given item index specified in [param item].
</description>
</method>
<method name="local_to_map" qualifiers="const">
@@ -161,7 +161,7 @@
<param index="0" name="layer_number" type="int" />
<param index="1" name="value" type="bool" />
<description>
- Based on [code]value[/code], enables or disables the specified layer in the [member collision_layer], given a [code]layer_number[/code] between 1 and 32.
+ Based on [param value], enables or disables the specified layer in the [member collision_layer], given a [param layer_number] between 1 and 32.
</description>
</method>
<method name="set_collision_mask_value">
@@ -169,7 +169,7 @@
<param index="0" name="layer_number" type="int" />
<param index="1" name="value" type="bool" />
<description>
- Based on [code]value[/code], enables or disables the specified layer in the [member collision_mask], given a [code]layer_number[/code] between 1 and 32.
+ Based on [param value], enables or disables the specified layer in the [member collision_mask], given a [param layer_number] between 1 and 32.
</description>
</method>
<method name="set_navigation_map">