summaryrefslogtreecommitdiff
path: root/doc/classes/PackedByteArray.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/PackedByteArray.xml
parent35c1eae8d70eb6ae49495339b95f89bcd084c3f2 (diff)
Rename the argument tag to param in XML documentation
Diffstat (limited to 'doc/classes/PackedByteArray.xml')
-rw-r--r--doc/classes/PackedByteArray.xml146
1 files changed, 73 insertions, 73 deletions
diff --git a/doc/classes/PackedByteArray.xml b/doc/classes/PackedByteArray.xml
index 3af3bb8697..f7210122e6 100644
--- a/doc/classes/PackedByteArray.xml
+++ b/doc/classes/PackedByteArray.xml
@@ -17,14 +17,14 @@
</constructor>
<constructor name="PackedByteArray">
<return type="PackedByteArray" />
- <argument index="0" name="from" type="PackedByteArray" />
+ <param index="0" name="from" type="PackedByteArray" />
<description>
Constructs a [PackedByteArray] as a copy of the given [PackedByteArray].
</description>
</constructor>
<constructor name="PackedByteArray">
<return type="PackedByteArray" />
- <argument index="0" name="from" type="Array" />
+ <param index="0" name="from" type="Array" />
<description>
Constructs a new [PackedByteArray]. Optionally, you can pass in a generic [Array] that will be converted.
</description>
@@ -33,22 +33,22 @@
<methods>
<method name="append">
<return type="bool" />
- <argument index="0" name="value" type="int" />
+ <param index="0" name="value" type="int" />
<description>
Appends an element at the end of the array (alias of [method push_back]).
</description>
</method>
<method name="append_array">
<return type="void" />
- <argument index="0" name="array" type="PackedByteArray" />
+ <param index="0" name="array" type="PackedByteArray" />
<description>
Appends a [PackedByteArray] at the end of this array.
</description>
</method>
<method name="bsearch">
<return type="int" />
- <argument index="0" name="value" type="int" />
- <argument index="1" name="before" type="bool" default="true" />
+ <param index="0" name="value" type="int" />
+ <param index="1" name="before" type="bool" default="true" />
<description>
Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array.
[b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior.
@@ -56,110 +56,110 @@
</method>
<method name="compress" qualifiers="const">
<return type="PackedByteArray" />
- <argument index="0" name="compression_mode" type="int" default="0" />
+ <param index="0" name="compression_mode" type="int" default="0" />
<description>
Returns a new [PackedByteArray] with the data compressed. Set the compression mode using one of [enum File.CompressionMode]'s constants.
</description>
</method>
<method name="count" qualifiers="const">
<return type="int" />
- <argument index="0" name="value" type="int" />
+ <param index="0" name="value" type="int" />
<description>
Returns the number of times an element is in the array.
</description>
</method>
<method name="decode_double" qualifiers="const">
<return type="float" />
- <argument index="0" name="byte_offset" type="int" />
+ <param index="0" name="byte_offset" type="int" />
<description>
</description>
</method>
<method name="decode_float" qualifiers="const">
<return type="float" />
- <argument index="0" name="byte_offset" type="int" />
+ <param index="0" name="byte_offset" type="int" />
<description>
</description>
</method>
<method name="decode_half" qualifiers="const">
<return type="float" />
- <argument index="0" name="byte_offset" type="int" />
+ <param index="0" name="byte_offset" type="int" />
<description>
</description>
</method>
<method name="decode_s16" qualifiers="const">
<return type="int" />
- <argument index="0" name="byte_offset" type="int" />
+ <param index="0" name="byte_offset" type="int" />
<description>
</description>
</method>
<method name="decode_s32" qualifiers="const">
<return type="int" />
- <argument index="0" name="byte_offset" type="int" />
+ <param index="0" name="byte_offset" type="int" />
<description>
</description>
</method>
<method name="decode_s64" qualifiers="const">
<return type="int" />
- <argument index="0" name="byte_offset" type="int" />
+ <param index="0" name="byte_offset" type="int" />
<description>
</description>
</method>
<method name="decode_s8" qualifiers="const">
<return type="int" />
- <argument index="0" name="byte_offset" type="int" />
+ <param index="0" name="byte_offset" type="int" />
<description>
</description>
</method>
<method name="decode_u16" qualifiers="const">
<return type="int" />
- <argument index="0" name="byte_offset" type="int" />
+ <param index="0" name="byte_offset" type="int" />
<description>
</description>
</method>
<method name="decode_u32" qualifiers="const">
<return type="int" />
- <argument index="0" name="byte_offset" type="int" />
+ <param index="0" name="byte_offset" type="int" />
<description>
</description>
</method>
<method name="decode_u64" qualifiers="const">
<return type="int" />
- <argument index="0" name="byte_offset" type="int" />
+ <param index="0" name="byte_offset" type="int" />
<description>
</description>
</method>
<method name="decode_u8" qualifiers="const">
<return type="int" />
- <argument index="0" name="byte_offset" type="int" />
+ <param index="0" name="byte_offset" type="int" />
<description>
</description>
</method>
<method name="decode_var" qualifiers="const">
<return type="Variant" />
- <argument index="0" name="byte_offset" type="int" />
- <argument index="1" name="allow_objects" type="bool" default="false" />
+ <param index="0" name="byte_offset" type="int" />
+ <param index="1" name="allow_objects" type="bool" default="false" />
<description>
</description>
</method>
<method name="decode_var_size" qualifiers="const">
<return type="int" />
- <argument index="0" name="byte_offset" type="int" />
- <argument index="1" name="allow_objects" type="bool" default="false" />
+ <param index="0" name="byte_offset" type="int" />
+ <param index="1" name="allow_objects" type="bool" default="false" />
<description>
</description>
</method>
<method name="decompress" qualifiers="const">
<return type="PackedByteArray" />
- <argument index="0" name="buffer_size" type="int" />
- <argument index="1" name="compression_mode" type="int" default="0" />
+ <param index="0" name="buffer_size" type="int" />
+ <param index="1" name="compression_mode" type="int" default="0" />
<description>
Returns a new [PackedByteArray] with the data decompressed. Set [code]buffer_size[/code] to the size of the uncompressed data. Set the compression mode using one of [enum File.CompressionMode]'s constants.
</description>
</method>
<method name="decompress_dynamic" qualifiers="const">
<return type="PackedByteArray" />
- <argument index="0" name="max_output_size" type="int" />
- <argument index="1" name="compression_mode" type="int" default="0" />
+ <param index="0" name="max_output_size" type="int" />
+ <param index="1" name="compression_mode" type="int" default="0" />
<description>
Returns a new [PackedByteArray] with the data decompressed. Set the compression mode using one of [enum File.CompressionMode]'s constants. [b]This method only accepts gzip and deflate compression modes.[/b]
This method is potentially slower than [code]decompress[/code], as it may have to re-allocate its output buffer multiple times while decompressing, whereas [code]decompress[/code] knows it's output buffer size from the beginning.
@@ -174,100 +174,100 @@
</method>
<method name="encode_double">
<return type="void" />
- <argument index="0" name="byte_offset" type="int" />
- <argument index="1" name="value" type="float" />
+ <param index="0" name="byte_offset" type="int" />
+ <param index="1" name="value" type="float" />
<description>
</description>
</method>
<method name="encode_float">
<return type="void" />
- <argument index="0" name="byte_offset" type="int" />
- <argument index="1" name="value" type="float" />
+ <param index="0" name="byte_offset" type="int" />
+ <param index="1" name="value" type="float" />
<description>
</description>
</method>
<method name="encode_half">
<return type="void" />
- <argument index="0" name="byte_offset" type="int" />
- <argument index="1" name="value" type="float" />
+ <param index="0" name="byte_offset" type="int" />
+ <param index="1" name="value" type="float" />
<description>
</description>
</method>
<method name="encode_s16">
<return type="void" />
- <argument index="0" name="byte_offset" type="int" />
- <argument index="1" name="value" type="int" />
+ <param index="0" name="byte_offset" type="int" />
+ <param index="1" name="value" type="int" />
<description>
</description>
</method>
<method name="encode_s32">
<return type="void" />
- <argument index="0" name="byte_offset" type="int" />
- <argument index="1" name="value" type="int" />
+ <param index="0" name="byte_offset" type="int" />
+ <param index="1" name="value" type="int" />
<description>
</description>
</method>
<method name="encode_s64">
<return type="void" />
- <argument index="0" name="byte_offset" type="int" />
- <argument index="1" name="value" type="int" />
+ <param index="0" name="byte_offset" type="int" />
+ <param index="1" name="value" type="int" />
<description>
</description>
</method>
<method name="encode_s8">
<return type="void" />
- <argument index="0" name="byte_offset" type="int" />
- <argument index="1" name="value" type="int" />
+ <param index="0" name="byte_offset" type="int" />
+ <param index="1" name="value" type="int" />
<description>
</description>
</method>
<method name="encode_u16">
<return type="void" />
- <argument index="0" name="byte_offset" type="int" />
- <argument index="1" name="value" type="int" />
+ <param index="0" name="byte_offset" type="int" />
+ <param index="1" name="value" type="int" />
<description>
</description>
</method>
<method name="encode_u32">
<return type="void" />
- <argument index="0" name="byte_offset" type="int" />
- <argument index="1" name="value" type="int" />
+ <param index="0" name="byte_offset" type="int" />
+ <param index="1" name="value" type="int" />
<description>
</description>
</method>
<method name="encode_u64">
<return type="void" />
- <argument index="0" name="byte_offset" type="int" />
- <argument index="1" name="value" type="int" />
+ <param index="0" name="byte_offset" type="int" />
+ <param index="1" name="value" type="int" />
<description>
</description>
</method>
<method name="encode_u8">
<return type="void" />
- <argument index="0" name="byte_offset" type="int" />
- <argument index="1" name="value" type="int" />
+ <param index="0" name="byte_offset" type="int" />
+ <param index="1" name="value" type="int" />
<description>
</description>
</method>
<method name="encode_var">
<return type="int" />
- <argument index="0" name="byte_offset" type="int" />
- <argument index="1" name="value" type="Variant" />
- <argument index="2" name="allow_objects" type="bool" default="false" />
+ <param index="0" name="byte_offset" type="int" />
+ <param index="1" name="value" type="Variant" />
+ <param index="2" name="allow_objects" type="bool" default="false" />
<description>
</description>
</method>
<method name="fill">
<return type="void" />
- <argument index="0" name="value" type="int" />
+ <param index="0" name="value" type="int" />
<description>
Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements.
</description>
</method>
<method name="find" qualifiers="const">
<return type="int" />
- <argument index="0" name="value" type="int" />
- <argument index="1" name="from" type="int" default="0" />
+ <param index="0" name="value" type="int" />
+ <param index="1" name="from" type="int" default="0" />
<description>
Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed.
</description>
@@ -298,15 +298,15 @@
</method>
<method name="has" qualifiers="const">
<return type="bool" />
- <argument index="0" name="value" type="int" />
+ <param index="0" name="value" type="int" />
<description>
Returns [code]true[/code] if the array contains [code]value[/code].
</description>
</method>
<method name="has_encoded_var" qualifiers="const">
<return type="bool" />
- <argument index="0" name="byte_offset" type="int" />
- <argument index="1" name="allow_objects" type="bool" default="false" />
+ <param index="0" name="byte_offset" type="int" />
+ <param index="1" name="allow_objects" type="bool" default="false" />
<description>
</description>
</method>
@@ -328,8 +328,8 @@
</method>
<method name="insert">
<return type="int" />
- <argument index="0" name="at_index" type="int" />
- <argument index="1" name="value" type="int" />
+ <param index="0" name="at_index" type="int" />
+ <param index="1" name="value" type="int" />
<description>
Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]).
</description>
@@ -342,21 +342,21 @@
</method>
<method name="push_back">
<return type="bool" />
- <argument index="0" name="value" type="int" />
+ <param index="0" name="value" type="int" />
<description>
Appends an element at the end of the array.
</description>
</method>
<method name="remove_at">
<return type="void" />
- <argument index="0" name="index" type="int" />
+ <param index="0" name="index" type="int" />
<description>
Removes an element from the array by index.
</description>
</method>
<method name="resize">
<return type="int" />
- <argument index="0" name="new_size" type="int" />
+ <param index="0" name="new_size" type="int" />
<description>
Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size.
</description>
@@ -369,16 +369,16 @@
</method>
<method name="rfind" qualifiers="const">
<return type="int" />
- <argument index="0" name="value" type="int" />
- <argument index="1" name="from" type="int" default="-1" />
+ <param index="0" name="value" type="int" />
+ <param index="1" name="from" type="int" default="-1" />
<description>
Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array.
</description>
</method>
<method name="set">
<return type="void" />
- <argument index="0" name="index" type="int" />
- <argument index="1" name="value" type="int" />
+ <param index="0" name="index" type="int" />
+ <param index="1" name="value" type="int" />
<description>
Changes the byte at the given index.
</description>
@@ -391,8 +391,8 @@
</method>
<method name="slice" qualifiers="const">
<return type="PackedByteArray" />
- <argument index="0" name="begin" type="int" />
- <argument index="1" name="end" type="int" default="2147483647" />
+ <param index="0" name="begin" type="int" />
+ <param index="1" name="end" type="int" default="2147483647" />
<description>
Returns the slice of the [PackedByteArray], from [code]begin[/code] (inclusive) to [code]end[/code] (exclusive), as a new [PackedByteArray].
The absolute value of [code]begin[/code] and [code]end[/code] will be clamped to the array size, so the default value for [code]end[/code] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]).
@@ -441,25 +441,25 @@
<operators>
<operator name="operator !=">
<return type="bool" />
- <argument index="0" name="right" type="PackedByteArray" />
+ <param index="0" name="right" type="PackedByteArray" />
<description>
</description>
</operator>
<operator name="operator +">
<return type="PackedByteArray" />
- <argument index="0" name="right" type="PackedByteArray" />
+ <param index="0" name="right" type="PackedByteArray" />
<description>
</description>
</operator>
<operator name="operator ==">
<return type="bool" />
- <argument index="0" name="right" type="PackedByteArray" />
+ <param index="0" name="right" type="PackedByteArray" />
<description>
</description>
</operator>
<operator name="operator []">
<return type="int" />
- <argument index="0" name="index" type="int" />
+ <param index="0" name="index" type="int" />
<description>
</description>
</operator>