From f7f6115f7627df24a08a9a0882b2f573cc838eb1 Mon Sep 17 00:00:00 2001
From: Hugo Locurcio <hugo.locurcio@hugo.pro>
Date: Sat, 22 Jun 2019 01:04:47 +0200
Subject: Proofread and improve the whole class reference

- 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
---
 doc/classes/PoolColorArray.xml | 21 +++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)

(limited to 'doc/classes/PoolColorArray.xml')

diff --git a/doc/classes/PoolColorArray.xml b/doc/classes/PoolColorArray.xml
index efc3582ba4..a1fb868ef5 100644
--- a/doc/classes/PoolColorArray.xml
+++ b/doc/classes/PoolColorArray.xml
@@ -4,7 +4,8 @@
 		A pooled [Array] of [Color].
 	</brief_description>
 	<description>
-		An [Array] specifically designed to hold [Color]. 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 [Color]. 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 [PoolColorArray]. Optionally, you can pass in a generic [Array] that will be converted.
+				Constructs a new [PoolColorArray]. Optionally, you can pass in a generic [Array] that will be converted.
 			</description>
 		</method>
 		<method name="append">
 			<argument index="0" name="color" type="Color">
 			</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="PoolColorArray">
 			</argument>
 			<description>
-				Append a [PoolColorArray] at the end of this array.
+				Appends a [PoolColorArray] at the end of this array.
 			</description>
 		</method>
 		<method name="insert">
@@ -40,33 +41,33 @@
 			<argument index="1" name="color" type="Color">
 			</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="push_back">
 			<argument index="0" name="color" type="Color">
 			</argument>
 			<description>
-				Append a value to the array.
+				Appends a value to 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">
@@ -75,7 +76,7 @@
 			<argument index="1" name="color" type="Color">
 			</argument>
 			<description>
-				Change the [Color] at the given index.
+				Changes the [Color] at the given index.
 			</description>
 		</method>
 		<method name="size">
-- 
cgit v1.2.3