From 867dda112453b0c8e3903831baea570630c397f5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= <rverschelde@gmail.com>
Date: Wed, 26 Jun 2019 15:57:13 +0200
Subject: doc: Proofread and complete various nodes

All 100% completed: MainLoop, Node, Object, Path, Performance,
Reference, Resource, SceneState, SceneTree, UndoRedo.

Also fixed some en_GB occurrences as the reference spelling is en_US.
---
 doc/classes/Reference.xml | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

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

diff --git a/doc/classes/Reference.xml b/doc/classes/Reference.xml
index bc24483367..9e6c403873 100644
--- a/doc/classes/Reference.xml
+++ b/doc/classes/Reference.xml
@@ -1,10 +1,12 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="Reference" inherits="Object" category="Core" version="3.2">
 	<brief_description>
-		Base class for anything that keeps a reference count.
+		Base class for reference-counted objects.
 	</brief_description>
 	<description>
-		Base class for anything that keeps a reference count. Resource and many other helper objects inherit this. References keep an internal reference counter so they are only released when no longer in use.
+		Base class for any object that keeps a reference count. [Resource] and many other helper objects inherit this class.
+		References keep an internal reference counter so that they are automatically released when no longer in use, and only then. References therefore do not need to be freed manually with [method Object.free].
+		In the vast majority of use cases, instantiating and using [Reference]-derived types is all you need to do. The methods provided in this class are only for advanced users, and can cause issues if misused.
 	</description>
 	<tutorials>
 	</tutorials>
@@ -13,20 +15,24 @@
 			<return type="bool">
 			</return>
 			<description>
+				Initializes the internal reference counter. Use this only if you really know what you are doing.
+				Returns whether the initialization was successful.
 			</description>
 		</method>
 		<method name="reference">
 			<return type="bool">
 			</return>
 			<description>
-				Increase the internal reference counter. Use this only if you really know what you are doing.
+				Increments the internal reference counter. Use this only if you really know what you are doing.
+				Returns whether the increment was successful.
 			</description>
 		</method>
 		<method name="unreference">
 			<return type="bool">
 			</return>
 			<description>
-				Decrease the internal reference counter. Use this only if you really know what you are doing.
+				Decrements the internal reference counter. Use this only if you really know what you are doing.
+				Returns whether the decrement was successful.
 			</description>
 		</method>
 	</methods>
-- 
cgit v1.2.3