From 4fda4f31c236320133c23727f3298e0ff4f0fa76 Mon Sep 17 00:00:00 2001 From: Haoyu Qiu Date: Sat, 23 Apr 2022 11:07:55 +0800 Subject: [PATCH] Remove Array link in description of PoolArrays --- doc/classes/PoolByteArray.xml | 4 ++-- doc/classes/PoolColorArray.xml | 4 ++-- doc/classes/PoolIntArray.xml | 4 ++-- doc/classes/PoolRealArray.xml | 4 ++-- doc/classes/PoolStringArray.xml | 4 ++-- doc/classes/PoolVector2Array.xml | 4 ++-- doc/classes/PoolVector3Array.xml | 4 ++-- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/doc/classes/PoolByteArray.xml b/doc/classes/PoolByteArray.xml index 44d0e42fef2..10d48d3db24 100644 --- a/doc/classes/PoolByteArray.xml +++ b/doc/classes/PoolByteArray.xml @@ -1,10 +1,10 @@ - A pooled [Array] of bytes. + A pooled array of bytes. - An [Array] specifically designed to hold bytes. Optimized for memory usage, does not fragment the memory. + An array specifically designed to hold bytes. Optimized for memory usage, does not fragment the memory. [b]Note:[/b] This type is passed by value and not by reference. diff --git a/doc/classes/PoolColorArray.xml b/doc/classes/PoolColorArray.xml index 5f226b0149f..e2d711ecd93 100644 --- a/doc/classes/PoolColorArray.xml +++ b/doc/classes/PoolColorArray.xml @@ -1,10 +1,10 @@ - A pooled [Array] of [Color]. + A pooled array of [Color]. - An [Array] specifically designed to hold [Color]. Optimized for memory usage, does not fragment the memory. + An array specifically designed to hold [Color]. Optimized for memory usage, does not fragment the memory. [b]Note:[/b] This type is passed by value and not by reference. diff --git a/doc/classes/PoolIntArray.xml b/doc/classes/PoolIntArray.xml index 41e19ddc35b..75d1ba600ab 100644 --- a/doc/classes/PoolIntArray.xml +++ b/doc/classes/PoolIntArray.xml @@ -1,10 +1,10 @@ - A pooled [Array] of integers ([int]). + A pooled array of integers ([int]). - An [Array] specifically designed to hold integer values ([int]). Optimized for memory usage, does not fragment the memory. + An array specifically designed to hold integer values ([int]). Optimized for memory usage, does not fragment the memory. [b]Note:[/b] This type is passed by value and not by reference. [b]Note:[/b] This type is limited to signed 32-bit integers, which means it can only take values in the interval [code][-2^31, 2^31 - 1][/code], i.e. [code][-2147483648, 2147483647][/code]. Exceeding those bounds will wrap around. In comparison, [int] uses signed 64-bit integers which can hold much larger values. diff --git a/doc/classes/PoolRealArray.xml b/doc/classes/PoolRealArray.xml index 27f4c279c16..620af8b157f 100644 --- a/doc/classes/PoolRealArray.xml +++ b/doc/classes/PoolRealArray.xml @@ -1,10 +1,10 @@ - A pooled [Array] of reals ([float]). + A pooled array of reals ([float]). - An [Array] specifically designed to hold floating-point values. Optimized for memory usage, does not fragment the memory. + An array specifically designed to hold floating-point values. Optimized for memory usage, does not fragment the memory. [b]Note:[/b] This type is passed by value and not by reference. [b]Note:[/b] Unlike primitive [float]s which are 64-bit, numbers stored in [PoolRealArray] are 32-bit floats. This means values stored in [PoolRealArray] have lower precision compared to primitive [float]s. If you need to store 64-bit floats in an array, use a generic [Array] with [float] elements as these will still be 64-bit. However, using a generic [Array] to store [float]s will use roughly 6 times more memory compared to a [PoolRealArray]. diff --git a/doc/classes/PoolStringArray.xml b/doc/classes/PoolStringArray.xml index 12d5f1f83f8..88fd1dcc457 100644 --- a/doc/classes/PoolStringArray.xml +++ b/doc/classes/PoolStringArray.xml @@ -1,10 +1,10 @@ - A pooled [Array] of [String]. + A pooled array of [String]. - An [Array] specifically designed to hold [String]s. Optimized for memory usage, does not fragment the memory. + 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. diff --git a/doc/classes/PoolVector2Array.xml b/doc/classes/PoolVector2Array.xml index 15e29e8f7a0..af9b6f619f5 100644 --- a/doc/classes/PoolVector2Array.xml +++ b/doc/classes/PoolVector2Array.xml @@ -1,10 +1,10 @@ - A pooled [Array] of [Vector2]. + A pooled array of [Vector2]. - An [Array] specifically designed to hold [Vector2]. Optimized for memory usage, does not fragment the memory. + An array specifically designed to hold [Vector2]. Optimized for memory usage, does not fragment the memory. [b]Note:[/b] This type is passed by value and not by reference. diff --git a/doc/classes/PoolVector3Array.xml b/doc/classes/PoolVector3Array.xml index 69e97cefbbf..7f4276e2cc6 100644 --- a/doc/classes/PoolVector3Array.xml +++ b/doc/classes/PoolVector3Array.xml @@ -1,10 +1,10 @@ - A pooled [Array] of [Vector3]. + A pooled array of [Vector3]. - An [Array] specifically designed to hold [Vector3]. Optimized for memory usage, does not fragment the memory. + An array specifically designed to hold [Vector3]. Optimized for memory usage, does not fragment the memory. [b]Note:[/b] This type is passed by value and not by reference.