summaryrefslogtreecommitdiff
path: root/doc/classes/UndoRedo.xml
diff options
context:
space:
mode:
authorYuri Sizov <yuris@humnom.net>2022-08-06 21:11:48 +0300
committerYuri Sizov <yuris@humnom.net>2022-08-08 22:34:31 +0300
commitc5d7115038de5f83cb83e08748615a84fc26bee2 (patch)
tree13b9b42aac25f7769428ef91f637e260b768f25d /doc/classes/UndoRedo.xml
parent35c1eae8d70eb6ae49495339b95f89bcd084c3f2 (diff)
Rename the argument tag to param in XML documentation
Diffstat (limited to 'doc/classes/UndoRedo.xml')
-rw-r--r--doc/classes/UndoRedo.xml34
1 files changed, 17 insertions, 17 deletions
diff --git a/doc/classes/UndoRedo.xml b/doc/classes/UndoRedo.xml
index 80a548ceaf..4c955a7322 100644
--- a/doc/classes/UndoRedo.xml
+++ b/doc/classes/UndoRedo.xml
@@ -64,55 +64,55 @@
<methods>
<method name="add_do_method" qualifiers="vararg">
<return type="void" />
- <argument index="0" name="object" type="Object" />
- <argument index="1" name="method" type="StringName" />
+ <param index="0" name="object" type="Object" />
+ <param index="1" name="method" type="StringName" />
<description>
Register a method that will be called when the action is committed.
</description>
</method>
<method name="add_do_property">
<return type="void" />
- <argument index="0" name="object" type="Object" />
- <argument index="1" name="property" type="StringName" />
- <argument index="2" name="value" type="Variant" />
+ <param index="0" name="object" type="Object" />
+ <param index="1" name="property" type="StringName" />
+ <param index="2" name="value" type="Variant" />
<description>
Register a property value change for "do".
</description>
</method>
<method name="add_do_reference">
<return type="void" />
- <argument index="0" name="object" type="Object" />
+ <param index="0" name="object" type="Object" />
<description>
Register a reference for "do" that will be erased if the "do" history is lost. This is useful mostly for new nodes created for the "do" call. Do not use for resources.
</description>
</method>
<method name="add_undo_method" qualifiers="vararg">
<return type="void" />
- <argument index="0" name="object" type="Object" />
- <argument index="1" name="method" type="StringName" />
+ <param index="0" name="object" type="Object" />
+ <param index="1" name="method" type="StringName" />
<description>
Register a method that will be called when the action is undone.
</description>
</method>
<method name="add_undo_property">
<return type="void" />
- <argument index="0" name="object" type="Object" />
- <argument index="1" name="property" type="StringName" />
- <argument index="2" name="value" type="Variant" />
+ <param index="0" name="object" type="Object" />
+ <param index="1" name="property" type="StringName" />
+ <param index="2" name="value" type="Variant" />
<description>
Register a property value change for "undo".
</description>
</method>
<method name="add_undo_reference">
<return type="void" />
- <argument index="0" name="object" type="Object" />
+ <param index="0" name="object" type="Object" />
<description>
Register a reference for "undo" that will be erased if the "undo" history is lost. This is useful mostly for nodes removed with the "do" call (not the "undo" call!).
</description>
</method>
<method name="clear_history">
<return type="void" />
- <argument index="0" name="increase_version" type="bool" default="true" />
+ <param index="0" name="increase_version" type="bool" default="true" />
<description>
Clear the undo/redo history and associated references.
Passing [code]false[/code] to [code]increase_version[/code] will prevent the version number to be increased from this.
@@ -120,15 +120,15 @@
</method>
<method name="commit_action">
<return type="void" />
- <argument index="0" name="execute" type="bool" default="true" />
+ <param index="0" name="execute" type="bool" default="true" />
<description>
Commit the action. If [code]execute[/code] is true (default), all "do" methods/properties are called/set when this function is called.
</description>
</method>
<method name="create_action">
<return type="void" />
- <argument index="0" name="name" type="String" />
- <argument index="1" name="merge_mode" type="int" enum="UndoRedo.MergeMode" default="0" />
+ <param index="0" name="name" type="String" />
+ <param index="1" name="merge_mode" type="int" enum="UndoRedo.MergeMode" default="0" />
<description>
Create a new action. After this is called, do all your calls to [method add_do_method], [method add_undo_method], [method add_do_property], and [method add_undo_property], then commit the action with [method commit_action].
The way actions are merged is dictated by the [code]merge_mode[/code] argument. See [enum MergeMode] for details.
@@ -142,7 +142,7 @@
</method>
<method name="get_action_name">
<return type="String" />
- <argument index="0" name="id" type="int" />
+ <param index="0" name="id" type="int" />
<description>
Gets the action name from its index.
</description>