summaryrefslogtreecommitdiffstats
path: root/doc/classes/PoolRealArray.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2019-01-07 10:02:04 +0100
committerRémi Verschelde <rverschelde@gmail.com>2019-01-07 10:06:12 +0100
commit26fddb77be127ce3a88c70240e83af84236b544c (patch)
tree794031646582cec58852b84d50eebe4444fd1732 /doc/classes/PoolRealArray.xml
parent7d22e162e7ac3f880eae4d4b7fb8c71f80da0ba5 (diff)
downloadredot-engine-26fddb77be127ce3a88c70240e83af84236b544c.tar.gz
doc: Fix wrong references found by new makerst.py
Thanks @PJB3005
Diffstat (limited to 'doc/classes/PoolRealArray.xml')
-rw-r--r--doc/classes/PoolRealArray.xml10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/classes/PoolRealArray.xml b/doc/classes/PoolRealArray.xml
index c0c6ef8700..3eb485ce12 100644
--- a/doc/classes/PoolRealArray.xml
+++ b/doc/classes/PoolRealArray.xml
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolRealArray" category="Built-In Types" version="3.1">
<brief_description>
- Real Array.
+ A pooled [Array] of reals ([float]).
</brief_description>
<description>
- Real Array. Array of floating point values. Can only contain floats. Optimized for memory usage, can't fragment the memory. Note that this type is passed by value and not by reference.
+ An [Array] specifically designed to hold floating point values ([float]). Optimized for memory usage, does not fragment the memory. Note that this type is passed by value and not by reference.
</description>
<tutorials>
</tutorials>
@@ -17,7 +17,7 @@
<argument index="0" name="from" type="Array">
</argument>
<description>
- Create from a generic array.
+ Construct a new [code]PoolRealArray[/code]. Optionally, you can pass in a generic [Array] that will be converted.
</description>
</method>
<method name="append">
@@ -31,7 +31,7 @@
<argument index="0" name="array" type="PoolRealArray">
</argument>
<description>
- Append an [RealArray] at the end of this array.
+ Append a [code]PoolRealArray[/code] at the end of this array.
</description>
</method>
<method name="insert">
@@ -42,7 +42,7 @@
<argument index="1" name="value" type="float">
</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 (pos==size()).
+ 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]).
</description>
</method>
<method name="invert">