From a9cff880d6ace9a18859822e535c79041a070a49 Mon Sep 17 00:00:00 2001
From: Rémi Verschelde <rverschelde@gmail.com>
Date: Wed, 26 Jun 2019 10:50:45 +0200
Subject: doc: Document EncodedObjectAsID, expose its property

---
 doc/classes/EncodedObjectAsID.xml | 22 ++++++++--------------
 doc/classes/Object.xml            |  1 +
 2 files changed, 9 insertions(+), 14 deletions(-)

(limited to 'doc/classes')

diff --git a/doc/classes/EncodedObjectAsID.xml b/doc/classes/EncodedObjectAsID.xml
index 1822f6c199..6efdda48ef 100644
--- a/doc/classes/EncodedObjectAsID.xml
+++ b/doc/classes/EncodedObjectAsID.xml
@@ -1,27 +1,21 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="EncodedObjectAsID" inherits="Reference" category="Core" version="3.2">
 	<brief_description>
+		Holds a reference to an [Object]'s instance ID.
 	</brief_description>
 	<description>
+		Utility class which holds a reference to the internal identifier of an [Object] instance, as given by [method Object.get_instance_id]. This ID can then be used to retrieve the object instance with [method @GDScript.instance_from_id].
+		This class is used internally by the editor inspector and script debugger, but can also be used in plugins to pass and display objects as their IDs.
 	</description>
 	<tutorials>
 	</tutorials>
 	<methods>
-		<method name="get_object_id" qualifiers="const">
-			<return type="int">
-			</return>
-			<description>
-			</description>
-		</method>
-		<method name="set_object_id">
-			<return type="void">
-			</return>
-			<argument index="0" name="id" type="int">
-			</argument>
-			<description>
-			</description>
-		</method>
 	</methods>
+	<members>
+		<member name="object_id" type="int" setter="set_object_id" getter="get_object_id">
+			The [Object] identifier stored in this [EncodedObjectAsID] instance. The object instance can be retrieved with [method @GDScript.instance_from_id].
+		</member>
+	</members>
 	<constants>
 	</constants>
 </class>
diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml
index 548a0c18bb..a1fba1ac8d 100644
--- a/doc/classes/Object.xml
+++ b/doc/classes/Object.xml
@@ -203,6 +203,7 @@
 			</return>
 			<description>
 				Returns the object's unique instance ID.
+				This ID can be saved in [EncodedObjectAsID], and can be used to retrieve the object instance with [method @GDScript.instance_from_id].
 			</description>
 		</method>
 		<method name="get_meta" qualifiers="const">
-- 
cgit v1.2.3