summaryrefslogtreecommitdiff
path: root/doc/classes/CodeEdit.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/CodeEdit.xml
parent35c1eae8d70eb6ae49495339b95f89bcd084c3f2 (diff)
Rename the argument tag to param in XML documentation
Diffstat (limited to 'doc/classes/CodeEdit.xml')
-rw-r--r--doc/classes/CodeEdit.xml122
1 files changed, 61 insertions, 61 deletions
diff --git a/doc/classes/CodeEdit.xml b/doc/classes/CodeEdit.xml
index 4994ef352e..d9f8e17145 100644
--- a/doc/classes/CodeEdit.xml
+++ b/doc/classes/CodeEdit.xml
@@ -12,14 +12,14 @@
<methods>
<method name="_confirm_code_completion" qualifiers="virtual">
<return type="void" />
- <argument index="0" name="replace" type="bool" />
+ <param index="0" name="replace" type="bool" />
<description>
Override this method to define how the selected entry should be inserted. If [code]replace[/code] is true, any existing text should be replaced.
</description>
</method>
<method name="_filter_code_completion_candidates" qualifiers="virtual const">
<return type="Array" />
- <argument index="0" name="candidates" type="Dictionary[]" />
+ <param index="0" name="candidates" type="Dictionary[]" />
<description>
Override this method to define what items in [code]candidates[/code] should be displayed.
Both [code]candidates[/code] and the return is a [Array] of [Dictionary], see [method get_code_completion_option] for [Dictionary] content.
@@ -27,15 +27,15 @@
</method>
<method name="_request_code_completion" qualifiers="virtual">
<return type="void" />
- <argument index="0" name="force" type="bool" />
+ <param index="0" name="force" type="bool" />
<description>
Override this method to define what happens when the user requests code completion. If [code]force[/code] is true, any checks should be bypassed.
</description>
</method>
<method name="add_auto_brace_completion_pair">
<return type="void" />
- <argument index="0" name="start_key" type="String" />
- <argument index="1" name="end_key" type="String" />
+ <param index="0" name="start_key" type="String" />
+ <param index="1" name="end_key" type="String" />
<description>
Adds a brace pair.
Both the start and end keys must be symbols. Only the start key has to be unique.
@@ -43,12 +43,12 @@
</method>
<method name="add_code_completion_option">
<return type="void" />
- <argument index="0" name="type" type="int" enum="CodeEdit.CodeCompletionKind" />
- <argument index="1" name="display_text" type="String" />
- <argument index="2" name="insert_text" type="String" />
- <argument index="3" name="text_color" type="Color" default="Color(1, 1, 1, 1)" />
- <argument index="4" name="icon" type="Resource" default="null" />
- <argument index="5" name="value" type="Variant" default="0" />
+ <param index="0" name="type" type="int" enum="CodeEdit.CodeCompletionKind" />
+ <param index="1" name="display_text" type="String" />
+ <param index="2" name="insert_text" type="String" />
+ <param index="3" name="text_color" type="Color" default="Color(1, 1, 1, 1)" />
+ <param index="4" name="icon" type="Resource" default="null" />
+ <param index="5" name="value" type="Variant" default="0" />
<description>
Submits an item to the queue of potential candidates for the autocomplete menu. Call [method update_code_completion_options] to update the list.
[b]Note:[/b] This list will replace all current candidates.
@@ -56,9 +56,9 @@
</method>
<method name="add_comment_delimiter">
<return type="void" />
- <argument index="0" name="start_key" type="String" />
- <argument index="1" name="end_key" type="String" />
- <argument index="2" name="line_only" type="bool" default="false" />
+ <param index="0" name="start_key" type="String" />
+ <param index="1" name="end_key" type="String" />
+ <param index="2" name="line_only" type="bool" default="false" />
<description>
Adds a comment delimiter.
Both the start and end keys must be symbols. Only the start key has to be unique.
@@ -67,9 +67,9 @@
</method>
<method name="add_string_delimiter">
<return type="void" />
- <argument index="0" name="start_key" type="String" />
- <argument index="1" name="end_key" type="String" />
- <argument index="2" name="line_only" type="bool" default="false" />
+ <param index="0" name="start_key" type="String" />
+ <param index="1" name="end_key" type="String" />
+ <param index="2" name="line_only" type="bool" default="false" />
<description>
Adds a string delimiter.
Both the start and end keys must be symbols. Only the start key has to be unique.
@@ -78,7 +78,7 @@
</method>
<method name="can_fold_line" qualifiers="const">
<return type="bool" />
- <argument index="0" name="line" type="int" />
+ <param index="0" name="line" type="int" />
<description>
Returns if the given line is foldable, that is, it has indented lines right below it or a comment / string block.
</description>
@@ -121,7 +121,7 @@
</method>
<method name="confirm_code_completion">
<return type="void" />
- <argument index="0" name="replace" type="bool" default="false" />
+ <param index="0" name="replace" type="bool" default="false" />
<description>
Inserts the selected entry into the text. If [code]replace[/code] is true, any existing text is replaced rather then merged.
</description>
@@ -146,14 +146,14 @@
</method>
<method name="fold_line">
<return type="void" />
- <argument index="0" name="line" type="int" />
+ <param index="0" name="line" type="int" />
<description>
Folds the given line, if possible (see [method can_fold_line]).
</description>
</method>
<method name="get_auto_brace_completion_close_key" qualifiers="const">
<return type="String" />
- <argument index="0" name="open_key" type="String" />
+ <param index="0" name="open_key" type="String" />
<description>
Gets the matching auto brace close key for [code]open_key[/code].
</description>
@@ -172,7 +172,7 @@
</method>
<method name="get_code_completion_option" qualifiers="const">
<return type="Dictionary" />
- <argument index="0" name="index" type="int" />
+ <param index="0" name="index" type="int" />
<description>
Gets the completion option at [code]index[/code]. The return [Dictionary] has the following key-values:
[code]kind[/code]: [enum CodeCompletionKind]
@@ -197,30 +197,30 @@
</method>
<method name="get_delimiter_end_key" qualifiers="const">
<return type="String" />
- <argument index="0" name="delimiter_index" type="int" />
+ <param index="0" name="delimiter_index" type="int" />
<description>
Gets the end key for a string or comment region index.
</description>
</method>
<method name="get_delimiter_end_position" qualifiers="const">
<return type="Vector2" />
- <argument index="0" name="line" type="int" />
- <argument index="1" name="column" type="int" />
+ <param index="0" name="line" type="int" />
+ <param index="1" name="column" type="int" />
<description>
If [code]line[/code] [code]column[/code] is in a string or comment, returns the end position of the region. If not or no end could be found, both [Vector2] values will be [code]-1[/code].
</description>
</method>
<method name="get_delimiter_start_key" qualifiers="const">
<return type="String" />
- <argument index="0" name="delimiter_index" type="int" />
+ <param index="0" name="delimiter_index" type="int" />
<description>
Gets the start key for a string or comment region index.
</description>
</method>
<method name="get_delimiter_start_position" qualifiers="const">
<return type="Vector2" />
- <argument index="0" name="line" type="int" />
- <argument index="1" name="column" type="int" />
+ <param index="0" name="line" type="int" />
+ <param index="1" name="column" type="int" />
<description>
If [code]line[/code] [code]column[/code] is in a string or comment, returns the start position of the region. If not or no start could be found, both [Vector2] values will be [code]-1[/code].
</description>
@@ -251,28 +251,28 @@
</method>
<method name="has_auto_brace_completion_close_key" qualifiers="const">
<return type="bool" />
- <argument index="0" name="close_key" type="String" />
+ <param index="0" name="close_key" type="String" />
<description>
Returns [code]true[/code] if close key [code]close_key[/code] exists.
</description>
</method>
<method name="has_auto_brace_completion_open_key" qualifiers="const">
<return type="bool" />
- <argument index="0" name="open_key" type="String" />
+ <param index="0" name="open_key" type="String" />
<description>
Returns [code]true[/code] if open key [code]open_key[/code] exists.
</description>
</method>
<method name="has_comment_delimiter" qualifiers="const">
<return type="bool" />
- <argument index="0" name="start_key" type="String" />
+ <param index="0" name="start_key" type="String" />
<description>
Returns [code]true[/code] if comment [code]start_key[/code] exists.
</description>
</method>
<method name="has_string_delimiter" qualifiers="const">
<return type="bool" />
- <argument index="0" name="start_key" type="String" />
+ <param index="0" name="start_key" type="String" />
<description>
Returns [code]true[/code] if string [code]start_key[/code] exists.
</description>
@@ -285,124 +285,124 @@
</method>
<method name="is_in_comment" qualifiers="const">
<return type="int" />
- <argument index="0" name="line" type="int" />
- <argument index="1" name="column" type="int" default="-1" />
+ <param index="0" name="line" type="int" />
+ <param index="1" name="column" type="int" default="-1" />
<description>
Returns delimiter index if [code]line[/code] [code]column[/code] is in a comment. If [code]column[/code] is not provided, will return delimiter index if the entire [code]line[/code] is a comment. Otherwise [code]-1[/code].
</description>
</method>
<method name="is_in_string" qualifiers="const">
<return type="int" />
- <argument index="0" name="line" type="int" />
- <argument index="1" name="column" type="int" default="-1" />
+ <param index="0" name="line" type="int" />
+ <param index="1" name="column" type="int" default="-1" />
<description>
Returns the delimiter index if [code]line[/code] [code]column[/code] is in a string. If [code]column[/code] is not provided, will return the delimiter index if the entire [code]line[/code] is a string. Otherwise [code]-1[/code].
</description>
</method>
<method name="is_line_bookmarked" qualifiers="const">
<return type="bool" />
- <argument index="0" name="line" type="int" />
+ <param index="0" name="line" type="int" />
<description>
Returns whether the line at the specified index is bookmarked or not.
</description>
</method>
<method name="is_line_breakpointed" qualifiers="const">
<return type="bool" />
- <argument index="0" name="line" type="int" />
+ <param index="0" name="line" type="int" />
<description>
Returns whether the line at the specified index is breakpointed or not.
</description>
</method>
<method name="is_line_executing" qualifiers="const">
<return type="bool" />
- <argument index="0" name="line" type="int" />
+ <param index="0" name="line" type="int" />
<description>
Returns whether the line at the specified index is marked as executing or not.
</description>
</method>
<method name="is_line_folded" qualifiers="const">
<return type="bool" />
- <argument index="0" name="line" type="int" />
+ <param index="0" name="line" type="int" />
<description>
Returns whether the line at the specified index is folded or not.
</description>
</method>
<method name="remove_comment_delimiter">
<return type="void" />
- <argument index="0" name="start_key" type="String" />
+ <param index="0" name="start_key" type="String" />
<description>
Removes the comment delimiter with [code]start_key[/code].
</description>
</method>
<method name="remove_string_delimiter">
<return type="void" />
- <argument index="0" name="start_key" type="String" />
+ <param index="0" name="start_key" type="String" />
<description>
Removes the string delimiter with [code]start_key[/code].
</description>
</method>
<method name="request_code_completion">
<return type="void" />
- <argument index="0" name="force" type="bool" default="false" />
+ <param index="0" name="force" type="bool" default="false" />
<description>
Emits [signal code_completion_requested], if [code]force[/code] is true will bypass all checks. Otherwise will check that the caret is in a word or in front of a prefix. Will ignore the request if all current options are of type file path, node path or signal.
</description>
</method>
<method name="set_code_completion_selected_index">
<return type="void" />
- <argument index="0" name="index" type="int" />
+ <param index="0" name="index" type="int" />
<description>
Sets the current selected completion option.
</description>
</method>
<method name="set_code_hint">
<return type="void" />
- <argument index="0" name="code_hint" type="String" />
+ <param index="0" name="code_hint" type="String" />
<description>
Sets the code hint text. Pass an empty string to clear.
</description>
</method>
<method name="set_code_hint_draw_below">
<return type="void" />
- <argument index="0" name="draw_below" type="bool" />
+ <param index="0" name="draw_below" type="bool" />
<description>
Sets if the code hint should draw below the text.
</description>
</method>
<method name="set_line_as_bookmarked">
<return type="void" />
- <argument index="0" name="line" type="int" />
- <argument index="1" name="bookmarked" type="bool" />
+ <param index="0" name="line" type="int" />
+ <param index="1" name="bookmarked" type="bool" />
<description>
Sets the line as bookmarked.
</description>
</method>
<method name="set_line_as_breakpoint">
<return type="void" />
- <argument index="0" name="line" type="int" />
- <argument index="1" name="breakpointed" type="bool" />
+ <param index="0" name="line" type="int" />
+ <param index="1" name="breakpointed" type="bool" />
<description>
Sets the line as breakpointed.
</description>
</method>
<method name="set_line_as_executing">
<return type="void" />
- <argument index="0" name="line" type="int" />
- <argument index="1" name="executing" type="bool" />
+ <param index="0" name="line" type="int" />
+ <param index="1" name="executing" type="bool" />
<description>
Sets the line as executing.
</description>
</method>
<method name="set_symbol_lookup_word_as_valid">
<return type="void" />
- <argument index="0" name="valid" type="bool" />
+ <param index="0" name="valid" type="bool" />
<description>
Sets the symbol emitted by [signal symbol_validate] as a valid lookup.
</description>
</method>
<method name="toggle_foldable_line">
<return type="void" />
- <argument index="0" name="line" type="int" />
+ <param index="0" name="line" type="int" />
<description>
Toggle the folding of the code block at the given line.
</description>
@@ -415,7 +415,7 @@
</method>
<method name="unfold_line">
<return type="void" />
- <argument index="0" name="line" type="int" />
+ <param index="0" name="line" type="int" />
<description>
Unfolds all lines that were previously folded.
</description>
@@ -428,7 +428,7 @@
</method>
<method name="update_code_completion_options">
<return type="void" />
- <argument index="0" name="force" type="bool" />
+ <param index="0" name="force" type="bool" />
<description>
Submits all completion options added with [method add_code_completion_option]. Will try to force the autoccomplete menu to popup, if [code]force[/code] is [code]true[/code].
[b]Note:[/b] This will replace all current candidates.
@@ -501,7 +501,7 @@
</members>
<signals>
<signal name="breakpoint_toggled">
- <argument index="0" name="line" type="int" />
+ <param index="0" name="line" type="int" />
<description>
Emitted when a breakpoint is added or removed from a line. If the line is moved via backspace a removed is emitted at the old line.
</description>
@@ -512,15 +512,15 @@
</description>
</signal>
<signal name="symbol_lookup">
- <argument index="0" name="symbol" type="String" />
- <argument index="1" name="line" type="int" />
- <argument index="2" name="column" type="int" />
+ <param index="0" name="symbol" type="String" />
+ <param index="1" name="line" type="int" />
+ <param index="2" name="column" type="int" />
<description>
Emitted when the user has clicked on a valid symbol.
</description>
</signal>
<signal name="symbol_validate">
- <argument index="0" name="symbol" type="String" />
+ <param index="0" name="symbol" type="String" />
<description>
Emitted when the user hovers over a symbol. The symbol should be validated and responded to, by calling [method set_symbol_lookup_word_as_valid].
</description>