Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix misformatted documentation from recent PRs #47631

Merged
merged 1 commit into from
Apr 5, 2021
Merged

Fix misformatted documentation from recent PRs #47631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions doc/classes/Array.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
10 changes: 10 additions & 0 deletions doc/classes/ArrayMesh.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
14 changes: 7 additions & 7 deletions doc/classes/PackedByteArray.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
14 changes: 7 additions & 7 deletions doc/classes/PackedColorArray.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
14 changes: 7 additions & 7 deletions doc/classes/PackedFloat32Array.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
14 changes: 7 additions & 7 deletions doc/classes/PackedFloat64Array.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
14 changes: 7 additions & 7 deletions doc/classes/PackedInt32Array.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
14 changes: 7 additions & 7 deletions doc/classes/PackedInt64Array.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
14 changes: 7 additions & 7 deletions doc/classes/PackedStringArray.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
14 changes: 7 additions & 7 deletions doc/classes/PackedVector2Array.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
14 changes: 7 additions & 7 deletions doc/classes/PackedVector3Array.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
10 changes: 10 additions & 0 deletions doc/classes/Skeleton3D.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
12 changes: 6 additions & 6 deletions doc/classes/Texture2D.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,18 +63,18 @@
Draws a part of the texture using a [CanvasItem] with the [RenderingServer] API.
</description>
</method>
<method name="get_image" qualifiers="const">
<return type="Image">
<method name="get_height" qualifiers="const">
<return type="int">
</return>
<description>
Returns an [Image] that is a copy of data from this [Texture2D]. [Image]s can be accessed and manipulated directly.
Returns the texture height.
</description>
</method>
<method name="get_height" qualifiers="const">
<return type="int">
<method name="get_image" qualifiers="const">
<return type="Image">
</return>
<description>
Returns the texture height.
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">
Expand Down