summaryrefslogtreecommitdiffstats
path: root/modules/multiplayer/doc_classes/SceneReplicationConfig.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/multiplayer/doc_classes/SceneReplicationConfig.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/multiplayer/doc_classes/SceneReplicationConfig.xml')
-rw-r--r--modules/multiplayer/doc_classes/SceneReplicationConfig.xml16
1 files changed, 8 insertions, 8 deletions
diff --git a/modules/multiplayer/doc_classes/SceneReplicationConfig.xml b/modules/multiplayer/doc_classes/SceneReplicationConfig.xml
index 56ae219bab..53ea1d19a1 100644
--- a/modules/multiplayer/doc_classes/SceneReplicationConfig.xml
+++ b/modules/multiplayer/doc_classes/SceneReplicationConfig.xml
@@ -13,7 +13,7 @@
<param index="0" name="path" type="NodePath" />
<param index="1" name="index" type="int" default="-1" />
<description>
- Adds the property identified by the given [code]path[/code] to the list of the properties being synchronized, optionally passing an [code]index[/code].
+ Adds the property identified by the given [param path] to the list of the properties being synchronized, optionally passing an [param index].
</description>
</method>
<method name="get_properties" qualifiers="const">
@@ -26,28 +26,28 @@
<return type="bool" />
<param index="0" name="path" type="NodePath" />
<description>
- Returns whether the given [code]path[/code] is configured for synchronization.
+ Returns whether the given [param path] is configured for synchronization.
</description>
</method>
<method name="property_get_index" qualifiers="const">
<return type="int" />
<param index="0" name="path" type="NodePath" />
<description>
- Finds the index of the given [code]path[/code].
+ Finds the index of the given [param path].
</description>
</method>
<method name="property_get_spawn">
<return type="bool" />
<param index="0" name="path" type="NodePath" />
<description>
- Returns whether the property identified by the given [code]path[/code] is configured to be synchronized on spawn.
+ Returns whether the property identified by the given [param path] is configured to be synchronized on spawn.
</description>
</method>
<method name="property_get_sync">
<return type="bool" />
<param index="0" name="path" type="NodePath" />
<description>
- Returns whether the property identified by the given [code]path[/code] is configured to be synchronized on process.
+ Returns whether the property identified by the given [param path] is configured to be synchronized on process.
</description>
</method>
<method name="property_set_spawn">
@@ -55,7 +55,7 @@
<param index="0" name="path" type="NodePath" />
<param index="1" name="enabled" type="bool" />
<description>
- Sets whether the property identified by the given [code]path[/code] is configured to be synchronized on spawn.
+ Sets whether the property identified by the given [param path] is configured to be synchronized on spawn.
</description>
</method>
<method name="property_set_sync">
@@ -63,14 +63,14 @@
<param index="0" name="path" type="NodePath" />
<param index="1" name="enabled" type="bool" />
<description>
- Sets whether the property identified by the given [code]path[/code] is configured to be synchronized on process.
+ Sets whether the property identified by the given [param path] is configured to be synchronized on process.
</description>
</method>
<method name="remove_property">
<return type="void" />
<param index="0" name="path" type="NodePath" />
<description>
- Removes the property identified by the given [code]path[/code] from the configuration.
+ Removes the property identified by the given [param path] from the configuration.
</description>
</method>
</methods>