seedlingattempt/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename the argument tag to param in XML documentation

Browse Source
This commit is contained in:
Yuri Sizov
2022-08-06 21:11:48 +03:00
parent 35c1eae8d7
commit c5d7115038
432 changed files with 10529 additions and 10529 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
modules/regex/doc_classes/RegEx.xml
View File

@ -57,14 +57,14 @@
</method>
<method name="compile">
<return type="int" enum="Error" />
<argument index="0" name="pattern" type="String" />
<param index="0" name="pattern" type="String" />
<description>
Compiles and assign the search pattern to use. Returns [constant OK] if the compilation is successful. If an error is encountered, details are printed to standard output and an error is returned.
</description>
</method>
<method name="create_from_string" qualifiers="static">
<return type="RegEx" />
<argument index="0" name="pattern" type="String" />
<param index="0" name="pattern" type="String" />
<description>
Creates and compiles a new [RegEx] object.
</description>
@ -95,29 +95,29 @@
</method>
<method name="search" qualifiers="const">
<return type="RegExMatch" />
<argument index="0" name="subject" type="String" />
<argument index="1" name="offset" type="int" default="0" />
<argument index="2" name="end" type="int" default="-1" />
<param index="0" name="subject" type="String" />
<param index="1" name="offset" type="int" default="0" />
<param index="2" name="end" type="int" default="-1" />
<description>
Searches the text for the compiled pattern. Returns a [RegExMatch] container of the first matching result if found, otherwise [code]null[/code]. The region to search within can be specified without modifying where the start and end anchor would be.
</description>
</method>
<method name="search_all" qualifiers="const">
<return type="RegExMatch[]" />
<argument index="0" name="subject" type="String" />
<argument index="1" name="offset" type="int" default="0" />
<argument index="2" name="end" type="int" default="-1" />
<param index="0" name="subject" type="String" />
<param index="1" name="offset" type="int" default="0" />
<param index="2" name="end" type="int" default="-1" />
<description>
Searches the text for the compiled pattern. Returns an array of [RegExMatch] containers for each non-overlapping result. If no results were found, an empty array is returned instead. The region to search within can be specified without modifying where the start and end anchor would be.
</description>
</method>
<method name="sub" qualifiers="const">
<return type="String" />
<argument index="0" name="subject" type="String" />
<argument index="1" name="replacement" type="String" />
<argument index="2" name="all" type="bool" default="false" />
<argument index="3" name="offset" type="int" default="0" />
<argument index="4" name="end" type="int" default="-1" />
<param index="0" name="subject" type="String" />
<param index="1" name="replacement" type="String" />
<param index="2" name="all" type="bool" default="false" />
<param index="3" name="offset" type="int" default="0" />
<param index="4" name="end" type="int" default="-1" />
<description>
Searches the text for the compiled pattern and replaces it with the specified string. Escapes and backreferences such as [code]$1[/code] and [code]$name[/code] are expanded and resolved. By default, only the first instance is replaced, but it can be changed for all instances (global replacement). The region to search within can be specified without modifying where the start and end anchor would be.
</description>

6
modules/regex/doc_classes/RegExMatch.xml
View File

@ -11,7 +11,7 @@
<methods>
<method name="get_end" qualifiers="const">
<return type="int" />
<argument index="0" name="name" type="Variant" default="0" />
<param index="0" name="name" type="Variant" default="0" />
<description>
Returns the end position of the match within the source string. The end position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern.
Returns -1 if the group did not match or doesn't exist.
@ -25,7 +25,7 @@
</method>
<method name="get_start" qualifiers="const">
<return type="int" />
<argument index="0" name="name" type="Variant" default="0" />
<param index="0" name="name" type="Variant" default="0" />
<description>
Returns the starting position of the match within the source string. The starting position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern.
Returns -1 if the group did not match or doesn't exist.
@ -33,7 +33,7 @@
</method>
<method name="get_string" qualifiers="const">
<return type="String" />
<argument index="0" name="name" type="Variant" default="0" />
<param index="0" name="name" type="Variant" default="0" />
<description>
Returns the substring of the match from the source string. Capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern.
Returns an empty string if the group did not match or doesn't exist.