asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #47631 from pycbouh/update-misformatted-docs

Browse source 
Fix misformatted documentation from recent PRs
This commit is contained in:
Rémi Verschelde 2021-04-05 11:36:24 +02:00 committed by GitHub
commit 40c56f924b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 97 additions and 77 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
doc/classes/Array.xml
View file

@ -328,13 +328,6 @@
[b]Note:[/b] On large arrays, this method will be slower if the inserted element is close to the beginning of the array (index 0). This is because all elements placed after the newly inserted element have to be reindexed.
</description>
</method>
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty" qualifiers="const">
<return type="bool">
</return>
@ -474,6 +467,13 @@
Resizes the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are [code]null[/code].
</description>
</method>
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="rfind" qualifiers="const">
<return type="int">
</return>

10
doc/classes/ArrayMesh.xml
View file

@ -128,6 +128,16 @@
Will regenerate normal maps for the [ArrayMesh].
</description>
</method>
<method name="set_blend_shape_name">
<return type="void">
</return>
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="name" type="StringName">
</argument>
<description>
</description>
</method>
<method name="surface_find_by_name" qualifiers="const">
<return type="int">
</return>

14
doc/classes/PackedByteArray.xml
View file

@ -157,13 +157,6 @@
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>
</method>
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty" qualifiers="const">
<return type="bool">
</return>
@ -230,6 +223,13 @@
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>
</method>
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="set">
<return type="void">
</return>

14
doc/classes/PackedColorArray.xml
View file

@ -79,13 +79,6 @@
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>
</method>
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty" qualifiers="const">
<return type="bool">
</return>
@ -152,6 +145,13 @@
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>
</method>
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="set">
<return type="void">
</return>

14
doc/classes/PackedFloat32Array.xml
View file

@ -80,13 +80,6 @@
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>
</method>
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty" qualifiers="const">
<return type="bool">
</return>
@ -145,6 +138,13 @@
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>
</method>
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="set">
<return type="void">
</return>

14
doc/classes/PackedFloat64Array.xml
View file

@ -80,13 +80,6 @@
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>
</method>
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty" qualifiers="const">
<return type="bool">
</return>
@ -153,6 +146,13 @@
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>
</method>
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="set">
<return type="void">
</return>

14
doc/classes/PackedInt32Array.xml
View file

@ -80,13 +80,6 @@
Inserts a new integer at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]).
</description>
</method>
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty" qualifiers="const">
<return type="bool">
</return>
@ -153,6 +146,13 @@
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>
</method>
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="set">
<return type="void">
</return>

14
doc/classes/PackedInt64Array.xml
View file

@ -80,13 +80,6 @@
Inserts a new integer at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]).
</description>
</method>
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty" qualifiers="const">
<return type="bool">
</return>
@ -153,6 +146,13 @@
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>
</method>
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="set">
<return type="void">
</return>

14
doc/classes/PackedStringArray.xml
View file

@ -80,13 +80,6 @@
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>
</method>
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty" qualifiers="const">
<return type="bool">
</return>
@ -153,6 +146,13 @@
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>
</method>
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="set">
<return type="void">
</return>

14
doc/classes/PackedVector2Array.xml
View file

@ -80,13 +80,6 @@
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>
</method>
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty" qualifiers="const">
<return type="bool">
</return>
@ -161,6 +154,13 @@
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>
</method>
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="set">
<return type="void">
</return>

14
doc/classes/PackedVector3Array.xml
View file

@ -79,13 +79,6 @@
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>
</method>
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty" qualifiers="const">
<return type="bool">
</return>
@ -160,6 +153,13 @@
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>
</method>
<method name="reverse">
<return type="void">
</return>
<description>
Reverses the order of the elements in the array.
</description>
</method>
<method name="set">
<return type="void">
</return>

10
doc/classes/Skeleton3D.xml
View file

@ -245,6 +245,16 @@
[b]Note[/b]: The pose transform needs to be in bone space. Use [method world_transform_to_bone_transform] to convert a world transform, like one you can get from a [Node3D], to bone space.
</description>
</method>
<method name="set_bone_name">
<return type="void">
</return>
<argument index="0" name="bone_idx" type="int">
</argument>
<argument index="1" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="set_bone_parent">
<return type="void">
</return>

14
doc/classes/Texture2D.xml
View file

@ -63,13 +63,6 @@
Draws a part of the texture using a [CanvasItem] with the [RenderingServer] API.
</description>
</method>
<method name="get_image" qualifiers="const">
<return type="Image">
</return>
<description>
Returns an [Image] that is a copy of data from this [Texture2D]. [Image]s can be accessed and manipulated directly.
</description>
</method>
<method name="get_height" qualifiers="const">
<return type="int">
</return>
@ -77,6 +70,13 @@
Returns the texture height.
</description>
</method>
<method name="get_image" qualifiers="const">
<return type="Image">
</return>
<description>
Returns an [Image] that is a copy of data from this [Texture2D]. [Image]s can be accessed and manipulated directly.
</description>
</method>
<method name="get_size" qualifiers="const">
<return type="Vector2">
</return>