doc: Sync with current 3.5 branch (8ee69a88c)

This commit is contained in:
Rémi Verschelde
2022-04-29 14:16:57 +02:00
parent 94366cdd8f
commit 12786907c6
398 changed files with 9782 additions and 3681 deletions

View File

@@ -9,14 +9,14 @@
PoolStringArray
===============
A pooled :ref:`Array<class_Array>` of :ref:`String<class_String>`.
A pooled array of :ref:`String<class_String>`.
Description
-----------
An :ref:`Array<class_Array>` specifically designed to hold :ref:`String<class_String>`\ s. Optimized for memory usage, does not fragment the memory.
An array specifically designed to hold :ref:`String<class_String>`\ s. Optimized for memory usage, does not fragment the memory.
**Note:** This type is passed by value and not by reference.
\ **Note:** This type is passed by value and not by reference.
Tutorials
---------
@@ -35,6 +35,8 @@ Methods
+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`empty<class_PoolStringArray_method_empty>` **(** **)** |
+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`fill<class_PoolStringArray_method_fill>` **(** :ref:`String<class_String>` string **)** |
+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`insert<class_PoolStringArray_method_insert>` **(** :ref:`int<class_int>` idx, :ref:`String<class_String>` string **)** |
+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`invert<class_PoolStringArray_method_invert>` **(** **)** |
@@ -87,6 +89,14 @@ Returns ``true`` if the array is empty.
----
.. _class_PoolStringArray_method_fill:
- void **fill** **(** :ref:`String<class_String>` string **)**
Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize<class_PoolStringArray_method_resize>` to create an array with a given size and initialized elements.
----
.. _class_PoolStringArray_method_insert:
- :ref:`int<class_int>` **insert** **(** :ref:`int<class_int>` idx, :ref:`String<class_String>` string **)**
@@ -147,7 +157,7 @@ Changes the :ref:`String<class_String>` at the given index.
- :ref:`int<class_int>` **size** **(** **)**
Returns the size of the array.
Returns the number of elements in the array.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`