Browse Source

doc: Sync classref with current source

Rémi Verschelde 4 years ago
parent
commit
7c3602dc8c
4 changed files with 33 additions and 22 deletions
  1. 12 6
      core/global_constants.cpp
  2. 6 9
      doc/classes/@GlobalScope.xml
  3. 7 7
      doc/classes/GraphNode.xml
  4. 8 0
      doc/classes/Tree.xml

+ 12 - 6
core/global_constants.cpp

@@ -409,6 +409,12 @@ void register_global_constants() {
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_BUTTON_13);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_BUTTON_13);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_BUTTON_14);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_BUTTON_14);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_BUTTON_15);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_BUTTON_15);
+	BIND_GLOBAL_ENUM_CONSTANT(JOY_BUTTON_16);
+	BIND_GLOBAL_ENUM_CONSTANT(JOY_BUTTON_17);
+	BIND_GLOBAL_ENUM_CONSTANT(JOY_BUTTON_18);
+	BIND_GLOBAL_ENUM_CONSTANT(JOY_BUTTON_19);
+	BIND_GLOBAL_ENUM_CONSTANT(JOY_BUTTON_20);
+	BIND_GLOBAL_ENUM_CONSTANT(JOY_BUTTON_21);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_BUTTON_MAX);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_BUTTON_MAX);
 
 
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_SONY_CIRCLE);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_SONY_CIRCLE);
@@ -442,18 +448,18 @@ void register_global_constants() {
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_DPAD_DOWN);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_DPAD_DOWN);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_DPAD_LEFT);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_DPAD_LEFT);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_DPAD_RIGHT);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_DPAD_RIGHT);
-	BIND_GLOBAL_ENUM_CONSTANT(JOY_L);
-	BIND_GLOBAL_ENUM_CONSTANT(JOY_L2);
-	BIND_GLOBAL_ENUM_CONSTANT(JOY_L3);
-	BIND_GLOBAL_ENUM_CONSTANT(JOY_R);
-	BIND_GLOBAL_ENUM_CONSTANT(JOY_R2);
-	BIND_GLOBAL_ENUM_CONSTANT(JOY_R3);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_MISC1);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_MISC1);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_PADDLE1);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_PADDLE1);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_PADDLE2);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_PADDLE2);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_PADDLE3);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_PADDLE3);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_PADDLE4);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_PADDLE4);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_TOUCHPAD);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_TOUCHPAD);
+	BIND_GLOBAL_ENUM_CONSTANT(JOY_L);
+	BIND_GLOBAL_ENUM_CONSTANT(JOY_L2);
+	BIND_GLOBAL_ENUM_CONSTANT(JOY_L3);
+	BIND_GLOBAL_ENUM_CONSTANT(JOY_R);
+	BIND_GLOBAL_ENUM_CONSTANT(JOY_R2);
+	BIND_GLOBAL_ENUM_CONSTANT(JOY_R3);
 
 
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_AXIS_0);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_AXIS_0);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_AXIS_1);
 	BIND_GLOBAL_ENUM_CONSTANT(JOY_AXIS_1);

+ 6 - 9
doc/classes/@GlobalScope.xml

@@ -30,9 +30,6 @@
 		<member name="Geometry" type="Geometry" setter="" getter="">
 		<member name="Geometry" type="Geometry" setter="" getter="">
 			The [Geometry] singleton.
 			The [Geometry] singleton.
 		</member>
 		</member>
-		<member name="GodotSharp" type="GodotSharp" setter="" getter="">
-			The [GodotSharp] singleton.
-		</member>
 		<member name="IP" type="IP" setter="" getter="">
 		<member name="IP" type="IP" setter="" getter="">
 			The [IP] singleton.
 			The [IP] singleton.
 		</member>
 		</member>
@@ -1084,22 +1081,22 @@
 		<constant name="JOY_DPAD_RIGHT" value="15" enum="JoystickList">
 		<constant name="JOY_DPAD_RIGHT" value="15" enum="JoystickList">
 			Gamepad DPad right.
 			Gamepad DPad right.
 		</constant>
 		</constant>
-		<constant name="JOY_MISC1" value="16" enum="JoyButtonList">
+		<constant name="JOY_MISC1" value="16" enum="JoystickList">
 			Gamepad SDL miscellaneous button.
 			Gamepad SDL miscellaneous button.
 		</constant>
 		</constant>
-		<constant name="JOY_PADDLE1" value="17" enum="JoyButtonList">
+		<constant name="JOY_PADDLE1" value="17" enum="JoystickList">
 			Gamepad SDL paddle 1 button.
 			Gamepad SDL paddle 1 button.
 		</constant>
 		</constant>
-		<constant name="JOY_PADDLE2" value="18" enum="JoyButtonList">
+		<constant name="JOY_PADDLE2" value="18" enum="JoystickList">
 			Gamepad SDL paddle 2 button.
 			Gamepad SDL paddle 2 button.
 		</constant>
 		</constant>
-		<constant name="JOY_PADDLE3" value="19" enum="JoyButtonList">
+		<constant name="JOY_PADDLE3" value="19" enum="JoystickList">
 			Gamepad SDL paddle 3 button.
 			Gamepad SDL paddle 3 button.
 		</constant>
 		</constant>
-		<constant name="JOY_PADDLE4" value="20" enum="JoyButtonList">
+		<constant name="JOY_PADDLE4" value="20" enum="JoystickList">
 			Gamepad SDL paddle 4 button.
 			Gamepad SDL paddle 4 button.
 		</constant>
 		</constant>
-		<constant name="JOY_TOUCHPAD" value="21" enum="JoyButtonList">
+		<constant name="JOY_TOUCHPAD" value="21" enum="JoystickList">
 			Gamepad SDL touchpad button.
 			Gamepad SDL touchpad button.
 		</constant>
 		</constant>
 		<constant name="JOY_L" value="4" enum="JoystickList">
 		<constant name="JOY_L" value="4" enum="JoystickList">

+ 7 - 7
doc/classes/GraphNode.xml

@@ -226,13 +226,6 @@
 				Emitted when the GraphNode is moved.
 				Emitted when the GraphNode is moved.
 			</description>
 			</description>
 		</signal>
 		</signal>
-		<signal name="slot_updated">
-			<argument index="0" name="idx" type="int">
-			</argument>
-			<description>
-				Emitted when any GraphNode's slot is updated.
-			</description>
-		</signal>
 		<signal name="raise_request">
 		<signal name="raise_request">
 			<description>
 			<description>
 				Emitted when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode.
 				Emitted when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode.
@@ -245,6 +238,13 @@
 				Emitted when the GraphNode is requested to be resized. Happens on dragging the resizer handle (see [member resizable]).
 				Emitted when the GraphNode is requested to be resized. Happens on dragging the resizer handle (see [member resizable]).
 			</description>
 			</description>
 		</signal>
 		</signal>
+		<signal name="slot_updated">
+			<argument index="0" name="idx" type="int">
+			</argument>
+			<description>
+				Emitted when any GraphNode's slot is updated.
+			</description>
+		</signal>
 	</signals>
 	</signals>
 	<constants>
 	<constants>
 		<constant name="OVERLAY_DISABLED" value="0" enum="Overlay">
 		<constant name="OVERLAY_DISABLED" value="0" enum="Overlay">

+ 8 - 0
doc/classes/Tree.xml

@@ -192,6 +192,14 @@
 				To tell whether a column of an item is selected, use [method TreeItem.is_selected].
 				To tell whether a column of an item is selected, use [method TreeItem.is_selected].
 			</description>
 			</description>
 		</method>
 		</method>
+		<method name="scroll_to_item">
+			<return type="void">
+			</return>
+			<argument index="0" name="item" type="Object">
+			</argument>
+			<description>
+			</description>
+		</method>
 		<method name="set_column_expand">
 		<method name="set_column_expand">
 			<return type="void">
 			<return type="void">
 			</return>
 			</return>