From 72aa87758a6c7795dc488cda45ccbd37f71de9a7 Mon Sep 17 00:00:00 2001
From: Poommetee Ketson <poommetee@protonmail.com>
Date: Sat, 24 Mar 2018 00:57:58 +0700
Subject: Update classref and docs, fix missing parameters' name

---
 doc/classes/ARVRServer.xml   | 18 +++---------------
 doc/classes/Camera.xml       |  2 +-
 doc/classes/EditorPlugin.xml |  2 ++
 doc/classes/ItemList.xml     |  7 +++++--
 doc/classes/OS.xml           |  4 ++--
 doc/classes/OptionButton.xml |  1 +
 doc/classes/PopupMenu.xml    |  1 +
 doc/classes/Vector2.xml      |  2 +-
 8 files changed, 16 insertions(+), 21 deletions(-)

(limited to 'doc')

diff --git a/doc/classes/ARVRServer.xml b/doc/classes/ARVRServer.xml
index 3164d0c2c3..a7d3e46684 100644
--- a/doc/classes/ARVRServer.xml
+++ b/doc/classes/ARVRServer.xml
@@ -40,6 +40,7 @@
 			<return type="Transform">
 			</return>
 			<description>
+				Returns the primary interface's transformation.
 			</description>
 		</method>
 		<method name="get_interface" qualifiers="const">
@@ -83,12 +84,6 @@
 			<description>
 			</description>
 		</method>
-		<method name="get_primary_interface" qualifiers="const">
-			<return type="ARVRInterface">
-			</return>
-			<description>
-			</description>
-		</method>
 		<method name="get_reference_frame" qualifiers="const">
 			<return type="Transform">
 			</return>
@@ -112,17 +107,10 @@
 				Get the number of trackers currently registered.
 			</description>
 		</method>
-		<method name="set_primary_interface">
-			<return type="void">
-			</return>
-			<argument index="0" name="interface" type="ARVRInterface">
-			</argument>
-			<description>
-				Changes the primary interface to the specified interface. Again mostly exposed for GDNative interfaces.
-			</description>
-		</method>
 	</methods>
 	<members>
+		<member name="primary_interface" type="ARVRInterface" setter="set_primary_interface" getter="get_primary_interface">
+		</member>
 		<member name="world_scale" type="float" setter="set_world_scale" getter="get_world_scale">
 			Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 meter in the real world.
 		</member>
diff --git a/doc/classes/Camera.xml b/doc/classes/Camera.xml
index 1260b369f5..7f7f152ae9 100644
--- a/doc/classes/Camera.xml
+++ b/doc/classes/Camera.xml
@@ -17,7 +17,7 @@
 			<argument index="0" name="enable_next" type="bool" default="true">
 			</argument>
 			<description>
-				If this is the current Camera, remove it from being current. If it is inside the node tree and [code]enabled_next[/code] is [code]true[/true], request to make the next Camera current, if any.
+				If this is the current Camera, remove it from being current. If [code]enable_next[/code] is true, request to make the next Camera current, if any.
 			</description>
 		</method>
 		<method name="get_camera_transform" qualifiers="const">
diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml
index a98cbf0316..846d6f18ff 100644
--- a/doc/classes/EditorPlugin.xml
+++ b/doc/classes/EditorPlugin.xml
@@ -114,6 +114,7 @@
 			<argument index="3" name="ud" type="Variant" default="null">
 			</argument>
 			<description>
+				Adds a custom menu to 'Project > Tools' as [code]name[/code] that calls [code]callback[/code] on an instance of [code]handler[/code] with a parameter [code]ud[/code] when user activates it.
 			</description>
 		</method>
 		<method name="add_tool_submenu_item">
@@ -367,6 +368,7 @@
 			<argument index="0" name="name" type="String">
 			</argument>
 			<description>
+				Removes a menu [code]name[/code] from 'Project > Tools'.
 			</description>
 		</method>
 		<method name="save_external_data" qualifiers="virtual">
diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml
index 4539c31441..bd1d6be4f5 100644
--- a/doc/classes/ItemList.xml
+++ b/doc/classes/ItemList.xml
@@ -148,6 +148,7 @@
 			<return type="bool">
 			</return>
 			<description>
+				Returns [code]true[/code] if one or more items are selected.
 			</description>
 		</method>
 		<method name="is_item_disabled" qualifiers="const">
@@ -189,11 +190,12 @@
 		<method name="move_item">
 			<return type="void">
 			</return>
-			<argument index="0" name="p_from_idx" type="int">
+			<argument index="0" name="from_idx" type="int">
 			</argument>
-			<argument index="1" name="p_to_idx" type="int">
+			<argument index="1" name="to_idx" type="int">
 			</argument>
 			<description>
+				Moves item at index [code]from_idx[/code] to [code]to_idx[/code].
 			</description>
 		</method>
 		<method name="remove_item">
@@ -346,6 +348,7 @@
 			<return type="void">
 			</return>
 			<description>
+				Ensure there are no items selected.
 			</description>
 		</method>
 	</methods>
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index 1a3cdc34d7..d38a89874c 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -127,7 +127,7 @@
 		<method name="get_audio_driver_name" qualifiers="const">
 			<return type="String">
 			</return>
-			<argument index="0" name="arg0" type="int">
+			<argument index="0" name="driver" type="int">
 			</argument>
 			<description>
 				Returns the audio driver name for the given index.
@@ -418,7 +418,7 @@
 		<method name="get_video_driver_name" qualifiers="const">
 			<return type="String">
 			</return>
-			<argument index="0" name="arg0" type="int">
+			<argument index="0" name="driver" type="int">
 			</argument>
 			<description>
 			</description>
diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml
index 9957106177..8cb53dd98e 100644
--- a/doc/classes/OptionButton.xml
+++ b/doc/classes/OptionButton.xml
@@ -198,6 +198,7 @@
 			<argument index="0" name="ID" type="int">
 			</argument>
 			<description>
+				This signal is emitted when user navigated to an item using [code]ui_up[/code] or [code]ui_down[/code] action. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index).
 			</description>
 		</signal>
 		<signal name="item_selected">
diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml
index 12bff45291..166a4be2b0 100644
--- a/doc/classes/PopupMenu.xml
+++ b/doc/classes/PopupMenu.xml
@@ -495,6 +495,7 @@
 			<argument index="0" name="ID" type="int">
 			</argument>
 			<description>
+				This event is emitted when user navigated to an item of some id using [code]ui_up[/code] or [code]ui_down[/code] action.
 			</description>
 		</signal>
 		<signal name="id_pressed">
diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml
index c9fc7d3fb5..5ffe807606 100644
--- a/doc/classes/Vector2.xml
+++ b/doc/classes/Vector2.xml
@@ -87,7 +87,7 @@
 			<argument index="0" name="with" type="Vector2">
 			</argument>
 			<description>
-				Returns the 2-dimensional analog of the cross product with [code]b[/code].
+				Returns the 2-dimensional analog of the cross product with the given Vector2.
 			</description>
 		</method>
 		<method name="cubic_interpolate">
-- 
cgit v1.2.3