From d32803fdd687e9bdca165cc600533a0371495943 Mon Sep 17 00:00:00 2001 From: Andy Maloney Date: Fri, 12 Aug 2022 13:13:27 -0400 Subject: [doc] Use "param" instead of "code" to refer to parameters (7) --- doc/classes/CodeEdit.xml | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) (limited to 'doc/classes/CodeEdit.xml') diff --git a/doc/classes/CodeEdit.xml b/doc/classes/CodeEdit.xml index d9f8e17145..5277df399e 100644 --- a/doc/classes/CodeEdit.xml +++ b/doc/classes/CodeEdit.xml @@ -14,22 +14,22 @@ - Override this method to define how the selected entry should be inserted. If [code]replace[/code] is true, any existing text should be replaced. + Override this method to define how the selected entry should be inserted. If [param replace] is true, any existing text should be replaced. - 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. + Override this method to define what items in [param candidates] should be displayed. + Both [param candidates] and the return is a [Array] of [Dictionary], see [method get_code_completion_option] for [Dictionary] content. - Override this method to define what happens when the user requests code completion. If [code]force[/code] is true, any checks should be bypassed. + Override this method to define what happens when the user requests code completion. If [param force] is true, any checks should be bypassed. @@ -123,7 +123,7 @@ - Inserts the selected entry into the text. If [code]replace[/code] is true, any existing text is replaced rather then merged. + Inserts the selected entry into the text. If [param replace] is true, any existing text is replaced rather then merged. @@ -155,7 +155,7 @@ - Gets the matching auto brace close key for [code]open_key[/code]. + Gets the matching auto brace close key for [param open_key]. @@ -174,7 +174,7 @@ - Gets the completion option at [code]index[/code]. The return [Dictionary] has the following key-values: + Gets the completion option at [param index]. The return [Dictionary] has the following key-values: [code]kind[/code]: [enum CodeCompletionKind] [code]display_text[/code]: Text that is shown on the autocomplete menu. [code]insert_text[/code]: Text that is to be inserted when this item is selected. @@ -207,7 +207,7 @@ - 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]. + If [param line] [param column] 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]. @@ -222,7 +222,7 @@ - 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]. + If [param line] [param column] 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]. @@ -253,28 +253,28 @@ - Returns [code]true[/code] if close key [code]close_key[/code] exists. + Returns [code]true[/code] if close key [param close_key] exists. - Returns [code]true[/code] if open key [code]open_key[/code] exists. + Returns [code]true[/code] if open key [param open_key] exists. - Returns [code]true[/code] if comment [code]start_key[/code] exists. + Returns [code]true[/code] if comment [param start_key] exists. - Returns [code]true[/code] if string [code]start_key[/code] exists. + Returns [code]true[/code] if string [param start_key] exists. @@ -288,7 +288,7 @@ - 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]. + Returns delimiter index if [param line] [param column] is in a comment. If [param column] is not provided, will return delimiter index if the entire [param line] is a comment. Otherwise [code]-1[/code]. @@ -296,7 +296,7 @@ - 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]. + Returns the delimiter index if [param line] [param column] is in a string. If [param column] is not provided, will return the delimiter index if the entire [param line] is a string. Otherwise [code]-1[/code]. @@ -331,21 +331,21 @@ - Removes the comment delimiter with [code]start_key[/code]. + Removes the comment delimiter with [param start_key]. - Removes the string delimiter with [code]start_key[/code]. + Removes the string delimiter with [param start_key]. - 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. + Emits [signal code_completion_requested], if [param force] 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. @@ -430,7 +430,7 @@ - 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]. + Submits all completion options added with [method add_code_completion_option]. Will try to force the autoccomplete menu to popup, if [param force] is [code]true[/code]. [b]Note:[/b] This will replace all current candidates. -- cgit v1.2.3