godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-17 14:11:06 +00:00
Code Releases Wiki Activity

Proofread and improve the whole class reference

Browse Source 
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
  and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
This commit is contained in:
Hugo Locurcio
2019-06-22 01:04:47 +02:00
parent 538c8eec15
commit f7f6115f76
330 changed files with 2585 additions and 2474 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/classes/PoolStringArray.xml
View File

@@ -4,7 +4,8 @@
A pooled [Array] of [String].
</brief_description>
<description>
An [Array] specifically designed to hold [String]. Optimized for memory usage, does not fragment the memory. Note that this type is passed by value and not by reference.
An [Array] specifically designed to hold [String]s. Optimized for memory usage, does not fragment the memory.
[b]Note:[/b] This type is passed by value and not by reference.
</description>
<tutorials>
</tutorials>
@@ -15,21 +16,21 @@
<argument index="0" name="from" type="Array">
</argument>
<description>
Construct a new [PoolStringArray]. Optionally, you can pass in a generic [Array] that will be converted.
Constructs a new [PoolStringArray]. Optionally, you can pass in a generic [Array] that will be converted.
</description>
</method>
<method name="append">
<argument index="0" name="string" type="String">
</argument>
<description>
Append an element at the end of the array (alias of [method push_back]).
Appends an element at the end of the array (alias of [method push_back]).
</description>
</method>
<method name="append_array">
<argument index="0" name="array" type="PoolStringArray">
</argument>
<description>
Append a [PoolStringArray] at the end of this array.
Appends a [PoolStringArray] at the end of this array.
</description>
</method>
<method name="insert">
@@ -40,12 +41,12 @@
<argument index="1" name="string" type="String">
</argument>
<description>
Insert 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]).
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="invert">
<description>
Reverse the order of the elements in the array.
Reverses the order of the elements in the array.
</description>
</method>
<method name="join">
@@ -61,21 +62,21 @@
<argument index="0" name="string" type="String">
</argument>
<description>
Append a string element at end of the array.
Appends a string element at end of the array.
</description>
</method>
<method name="remove">
<argument index="0" name="idx" type="int">
</argument>
<description>
Remove an element from the array by index.
Removes an element from the array by index.
</description>
</method>
<method name="resize">
<argument index="0" name="idx" type="int">
</argument>
<description>
Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size.
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="set">
@@ -84,7 +85,7 @@
<argument index="1" name="string" type="String">
</argument>
<description>
Change the [String] at the given index.
Changes the [String] at the given index.
</description>
</method>
<method name="size">