diff options
Diffstat (limited to 'doc/classes/UndoRedo.xml')
| -rw-r--r-- | doc/classes/UndoRedo.xml | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/classes/UndoRedo.xml b/doc/classes/UndoRedo.xml index 4c955a7322..3ef59b1c39 100644 --- a/doc/classes/UndoRedo.xml +++ b/doc/classes/UndoRedo.xml @@ -67,7 +67,7 @@ <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. + Register a [param method] that will be called when the action is committed. </description> </method> <method name="add_do_property"> @@ -76,7 +76,7 @@ <param index="1" name="property" type="StringName" /> <param index="2" name="value" type="Variant" /> <description> - Register a property value change for "do". + Register a [param property] that would change its value to [param value] when the action is committed. </description> </method> <method name="add_do_reference"> @@ -91,7 +91,7 @@ <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. + Register a [param method] that will be called when the action is undone. </description> </method> <method name="add_undo_property"> @@ -100,7 +100,7 @@ <param index="1" name="property" type="StringName" /> <param index="2" name="value" type="Variant" /> <description> - Register a property value change for "undo". + Register a [param property] that would change its value to [param value] when the action is undone. </description> </method> <method name="add_undo_reference"> @@ -115,14 +115,14 @@ <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. + Passing [code]false[/code] to [param increase_version] will prevent the version number from increasing when the history is cleared. </description> </method> <method name="commit_action"> <return type="void" /> <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. + Commit the action. If [param execute] is [code]true[/code] (which it is by default), all "do" methods/properties are called/set when this function is called. </description> </method> <method name="create_action"> @@ -131,7 +131,7 @@ <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. + The way actions are merged is dictated by [param merge_mode]. See [enum MergeMode] for details. </description> </method> <method name="end_force_keep_in_merge_ends"> |