godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-04 12:00:25 +00:00
Code 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

14
doc/classes/Performance.xml
View File

@@ -15,9 +15,9 @@
<methods>
<method name="add_custom_monitor">
<return type="void" />
<argument index="0" name="id" type="StringName" />
<argument index="1" name="callable" type="Callable" />
<argument index="2" name="arguments" type="Array" default="[]" />
<param index="0" name="id" type="StringName" />
<param index="1" name="callable" type="Callable" />
<param index="2" name="arguments" type="Array" default="[]" />
<description>
Adds a custom monitor with the name [code]id[/code]. You can specify the category of the monitor using slash delimiters in [code]id[/code] (for example: [code]"Game/NumberOfNPCs"[/code]). If there is more than one slash delimiter, then the default category is used. The default category is [code]"Custom"[/code]. Prints an error if given [code]id[/code] is already present.
[codeblocks]
@@ -73,7 +73,7 @@
</method>
<method name="get_custom_monitor">
<return type="Variant" />
<argument index="0" name="id" type="StringName" />
<param index="0" name="id" type="StringName" />
<description>
Returns the value of custom monitor with given [code]id[/code]. The callable is called to get the value of custom monitor. See also [method has_custom_monitor]. Prints an error if the given [code]id[/code] is absent.
</description>
@@ -86,7 +86,7 @@
</method>
<method name="get_monitor" qualifiers="const">
<return type="float" />
<argument index="0" name="monitor" type="int" enum="Performance.Monitor" />
<param index="0" name="monitor" type="int" enum="Performance.Monitor" />
<description>
Returns the value of one of the available built-in monitors. You should provide one of the [enum Monitor] constants as the argument, like this:
[codeblocks]
@@ -108,14 +108,14 @@
</method>
<method name="has_custom_monitor">
<return type="bool" />
<argument index="0" name="id" type="StringName" />
<param index="0" name="id" type="StringName" />
<description>
Returns [code]true[/code] if custom monitor with the given [code]id[/code] is present, [code]false[/code] otherwise.
</description>
</method>
<method name="remove_custom_monitor">
<return type="void" />
<argument index="0" name="id" type="StringName" />
<param index="0" name="id" type="StringName" />
<description>
Removes the custom monitor with given [code]id[/code]. Prints an error if the given [code]id[/code] is already absent.
</description>