Merge pull request #2847 from akien-mga/pr-sync-doc

Sync doc template with code

1 files changed, 140 insertions, 83 deletions

diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index 32ff75efbd..44a7cccfe5 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -3197,6 +3197,24 @@
 			<description>
 			</description>
 		</method>
+		<method name="set_animation_process_mode">
+			<argument index="0" name="mode" type="int">
+			</argument>
+			<description>
+			</description>
+		</method>
+		<method name="get_animation_process_mode" qualifiers="const">
+			<return type="int">
+			</return>
+			<description>
+			</description>
+		</method>
+		<method name="advance">
+			<argument index="0" name="delta" type="float">
+			</argument>
+			<description>
+			</description>
+		</method>
 		<method name="reset">
 			<description>
 			</description>
@@ -5477,7 +5495,7 @@
 		</constant>
 	</constants>
 </class>
-<class name="ButtonGroup" inherits="Control" category="Core">
+<class name="ButtonGroup" inherits="BoxContainer" category="Core">
 	<brief_description>
 	Group of Buttons.
 	</brief_description>
@@ -5523,6 +5541,10 @@
 	</methods>
 	<constants>
 	</constants>
+	<theme_items>
+		<theme_item name="panel" type="StyleBox">
+		</theme_item>
+	</theme_items>
 </class>
 <class name="Camera" inherits="Spatial" category="Core">
 	<brief_description>
@@ -7165,7 +7187,7 @@
 			</description>
 		</method>
 		<method name="set_build_mode">
-			<argument index="0" name="build_mode" type="int">
+			<argument index="0" name="arg0" type="int">
 			</argument>
 			<description>
 			Set whether the polygon is to be a [ConvexPolygon2D] ([code]build_mode[/code]=0), or a [ConcavePolygon2D] ([code]build_mode[/code]=1).
@@ -7179,7 +7201,7 @@
 			</description>
 		</method>
 		<method name="set_trigger">
-			<argument index="0" name="enable" type="bool">
+			<argument index="0" name="arg0" type="bool">
 			</argument>
 			<description>
 			Set whether this polygon is a trigger. A trigger polygon detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked).
@@ -7314,7 +7336,7 @@
 	Color in RGBA format.
 	</brief_description>
 	<description>
-	A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1.  Some methods (such as set_modulate() ) may accept values > 1.
+	A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1.  Some methods (such as set_modulate() ) may accept values &gt; 1.
 	</description>
 	<methods>
 		<method name="blend">
@@ -8608,7 +8630,7 @@
 			<argument index="0" name="point_cloud" type="Vector2Array">
 			</argument>
 			<description>
-			Currently, this method does nothing. <!-- Create the point set from a point cloud. The resulting convex hull will be set as the shape. -->
+			Currently, this method does nothing.
 			</description>
 		</method>
 		<method name="set_points">
@@ -8889,12 +8911,12 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and
 			</description>
 		</method>
 		<method name="tesselate" qualifiers="const">
+			<return type="Vector2Array">
+			</return>
 			<argument index="0" name="max_stages" type="int" default="5">
 			</argument>
 			<argument index="1" name="tolerance_degrees" type="float" default="4">
 			</argument>
-			<return type="Vector2Array">
-			</return>
 			<description>
 			Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts.
 This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough.
@@ -8902,16 +8924,6 @@ This approximation makes straight segments between each point, then subdivides t
 "tolerance_degrees" controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided.
 			</description>
 		</method>
-		<method name="tesselate" qualifiers="const">
-			<return type="Vector2Array">
-			</return>
-			<argument index="0" name="max_stages" type="int" default="5">
-			</argument>
-			<argument index="1" name="tolerance_degrees" type="float" default="4">
-			</argument>
-			<description>
-			</description>
-		</method>
 	</methods>
 	<constants>
 	</constants>
@@ -9096,12 +9108,12 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and
 			</description>
 		</method>
 		<method name="tesselate" qualifiers="const">
+			<return type="Vector3Array">
+			</return>
 			<argument index="0" name="max_stages" type="int" default="5">
 			</argument>
 			<argument index="1" name="tolerance_degrees" type="float" default="4">
 			</argument>
-			<return type="Vector3Array">
-			</return>
 			<description>
 			Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts.
 This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough.
@@ -9109,16 +9121,6 @@ This approximation makes straight segments between each point, then subdivides t
 "tolerance_degrees" controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided.
 			</description>
 		</method>
-		<method name="tesselate" qualifiers="const">
-			<return type="Vector3Array">
-			</return>
-			<argument index="0" name="max_stages" type="int" default="5">
-			</argument>
-			<argument index="1" name="tolerance_degrees" type="float" default="4">
-			</argument>
-			<description>
-			</description>
-		</method>
 	</methods>
 	<constants>
 	</constants>
@@ -10779,6 +10781,14 @@ This approximation makes straight segments between each point, then subdivides t
 		</constant>
 		<constant name="FLAG_DISCARD_ALPHA" value="3">
 		</constant>
+		<constant name="LIGHT_SHADER_LAMBERT" value="0">
+		</constant>
+		<constant name="LIGHT_SHADER_WRAP" value="1">
+		</constant>
+		<constant name="LIGHT_SHADER_VELVET" value="2">
+		</constant>
+		<constant name="LIGHT_SHADER_TOON" value="3">
+		</constant>
 	</constants>
 </class>
 <class name="Font" inherits="Resource" category="Core">
@@ -12539,7 +12549,7 @@ This approximation makes straight segments between each point, then subdivides t
 			<argument index="3" name="verify_host" type="bool" default="true">
 			</argument>
 			<description>
-					Connect to a host. This needs to be done before any requests are sent.
+			Connect to a host. This needs to be done before any requests are sent.
 The host should not have http:// prepended but will strip the protocol identifier if provided.
 					
 verify_host will check the SSL identity of the host if set to true.
@@ -12563,10 +12573,9 @@ verify_host will check the SSL identity of the host if set to true.
 			<argument index="3" name="body" type="String" default="&quot;&quot;">
 			</argument>
 			<description>
-					Sends a request to the connected host. The url is the what is normally behind the hostname, 
-i.e; 
+			Sends a request to the connected host. The url is the what is normally behind the hostname, i.e:
 http://somehost.com/index.php
-url would be &quot;index.php&quot;
+url would be "index.php"
 					
 Headers are HTTP request headers
 					
@@ -12584,8 +12593,8 @@ var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, qu
 			</return>
 			<argument index="0" name="body" type="String">
 			</argument>
-				<description>
-					Stub function
+			<description>
+			Stub function
 			</description>
 		</method>
 		<method name="send_body_data">
@@ -12594,7 +12603,7 @@ var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, qu
 			<argument index="0" name="body" type="RawArray">
 			</argument>
 			<description>
-					Stub function
+			Stub function
 			</description>
 		</method>
 		<method name="close">
@@ -12647,14 +12656,14 @@ var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, qu
 			<argument index="0" name="bytes" type="int">
 			</argument>
 			<description>
-					Sets the size of the buffer used and maximum bytes to read per iteration
+			Sets the size of the buffer used and maximum bytes to read per iteration
 			</description>
 		</method>
 		<method name="set_blocking_mode">
 			<argument index="0" name="enabled" type="bool">
 			</argument>
 			<description>
-					If set to true, execute will wait until all data is read from the response.
+			If set to true, execute will wait until all data is read from the response.
 			</description>
 		</method>
 		<method name="is_blocking_mode_enabled" qualifiers="const">
@@ -12667,30 +12676,30 @@ var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, qu
 			<return type="int">
 			</return>
 			<description>
-					Returns a status string like STATUS_REQUESTING. Need to call [method poll] in order to get status updates.
+			Returns a status string like STATUS_REQUESTING. Need to call [method poll] in order to get status updates.
 			</description>
 		</method>
 		<method name="poll">
 			<return type="Error">
 			</return>
-				<description>
-					This needs to be called in order to have any request processed. Check results with [method get_status]
+			<description>
+			This needs to be called in order to have any request processed. Check results with [method get_status]
 			</description>
 		</method>
-        <method name="query_string_from_dict">
-            <return type="String">
-            </return>
-            <argument index="0" name="fields" type="Dictionary">
-            </argument>
-            <description>
-					Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary.
+		<method name="query_string_from_dict">
+			<return type="String">
+			</return>
+			<argument index="0" name="fields" type="Dictionary">
+			</argument>
+			<description>
+			Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary.
 					
 var fields = {"username": "user", "password": "pass"}
 String queryString = httpClient.query_string_from_dict(fields)
 					
 returns:= "username=user&amp;password=pass"
-            </description>
-        </method>
+			</description>
+		</method>
 	</methods>
 	<constants>
 		<constant name="METHOD_GET" value="0">
@@ -14471,6 +14480,12 @@ returns:= "username=user&amp;password=pass"
 			<description>
 			</description>
 		</method>
+		<method name="get_instance_path" qualifiers="const">
+			<return type="String">
+			</return>
+			<description>
+			</description>
+		</method>
 	</methods>
 	<constants>
 	</constants>
@@ -15920,6 +15935,18 @@ returns:= "username=user&amp;password=pass"
 	LineEdit provides a single line string editor, used for text fields.
 	</description>
 	<methods>
+		<method name="set_align">
+			<argument index="0" name="align" type="int">
+			</argument>
+			<description>
+			</description>
+		</method>
+		<method name="get_align" qualifiers="const">
+			<return type="int">
+			</return>
+			<description>
+			</description>
+		</method>
 		<method name="clear">
 			<description>
 			Clear the [LineEdit] text.
@@ -16033,6 +16060,14 @@ returns:= "username=user&amp;password=pass"
 		</signal>
 	</signals>
 	<constants>
+		<constant name="ALIGN_LEFT" value="0">
+		</constant>
+		<constant name="ALIGN_CENTER" value="1">
+		</constant>
+		<constant name="ALIGN_RIGHT" value="2">
+		</constant>
+		<constant name="ALIGN_FILL" value="3">
+		</constant>
 	</constants>
 	<theme_items>
 		<theme_item name="minimum_spaces" type="int">
@@ -16700,11 +16735,11 @@ returns:= "username=user&amp;password=pass"
 		</method>
 	</methods>
 	<members>
-		<member name="x" type="Vector2">
+		<member name="x" type="float">
 		</member>
-		<member name="y" type="Vector2">
+		<member name="y" type="float">
 		</member>
-		<member name="o" type="Vector2">
+		<member name="o" type="float">
 		</member>
 	</members>
 	<constants>
@@ -16751,6 +16786,8 @@ returns:= "username=user&amp;password=pass"
 		</theme_item>
 		<theme_item name="pressed" type="StyleBox">
 		</theme_item>
+		<theme_item name="focus" type="StyleBox">
+		</theme_item>
 		<theme_item name="disabled" type="StyleBox">
 		</theme_item>
 		<theme_item name="normal" type="StyleBox">
@@ -18602,6 +18639,18 @@ returns:= "username=user&amp;password=pass"
 			Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost.
 			</description>
 		</method>
+		<method name="set_scene_instance_load_placeholder">
+			<argument index="0" name="load_placeholder" type="bool">
+			</argument>
+			<description>
+			</description>
+		</method>
+		<method name="get_scene_instance_load_placeholder" qualifiers="const">
+			<return type="bool">
+			</return>
+			<description>
+			</description>
+		</method>
 		<method name="get_viewport" qualifiers="const">
 			<return type="Object">
 			</return>
@@ -21591,16 +21640,16 @@ This method controls whether the position between two cached points is interpola
 	</methods>
 	<constants>
 		<constant name="ROTATION_NONE" value="0">
-		Forbids the PathFollow to rotate.
+			Forbids the PathFollow to rotate.
 		</constant>
 		<constant name="ROTATION_Y" value="1">
-		Allows the PathFollow to rotate in the Y axis only.
+			Allows the PathFollow to rotate in the Y axis only.
 		</constant>
 		<constant name="ROTATION_XY" value="2">
-		Allows the PathFollow to rotate in both the X, and Y axes.
+			Allows the PathFollow to rotate in both the X, and Y axes.
 		</constant>
 		<constant name="ROTATION_XYZ" value="3">
-		Allows the PathFollow to rotate in any axis.
+			Allows the PathFollow to rotate in any axis.
 		</constant>
 	</constants>
 </class>
@@ -21715,10 +21764,6 @@ This method controls whether the position between two cached points is interpola
 			</description>
 		</method>
 	</methods>
-	<members>
-		<member name="lookahead" type="float">
-		</member>
-	</members>
 	<constants>
 	</constants>
 </class>
@@ -26075,6 +26120,14 @@ This method controls whether the position between two cached points is interpola
 			<description>
 			</description>
 		</method>
+		<method name="xform">
+			<return type="Vector3">
+			</return>
+			<argument index="0" name="v" type="Vector3">
+			</argument>
+			<description>
+			</description>
+		</method>
 		<method name="Quat">
 			<return type="Quat">
 			</return>
@@ -26886,27 +26939,22 @@ This method controls whether the position between two cached points is interpola
 	<methods>
 		<method name="compile">
 			<return type="int">
-			[OK] if the regular expression was valid. [FAIL] otherwise.
 			</return>
 			<argument index="0" name="pattern" type="String">
-			The string to be converted into a regular expression.
+			</argument>
+			<argument index="1" name="expanded" type="bool" default="true">
 			</argument>
 			<description>
-			Once created, a RegEx object needs a regular expression to be assigned to it. This method tries to convert the string given to an usable regular expression.
 			</description>
 		</method>
 		<method name="find" qualifiers="const">
 			<return type="int">
-			The position within the string (starting with 0) where the pattern was found. It will return -1 if the pattern was not found, it was invalid, or the start or end positions were beyond the string's end.
 			</return>
 			<argument index="0" name="text" type="String">
-			The text to search the pattern in.
 			</argument>
 			<argument index="1" name="start" type="int" default="0">
-			The position in the string (starting with 0) to start searching from.
 			</argument>
 			<argument index="2" name="end" type="int" default="-1">
-			The position in the string (starting with 0) to stop searching. A value less than the start position means "end of the string".
 			</argument>
 			<description>
 			This method tries to find the pattern within the string, and returns the position where it was found. It also stores any capturing group (see [method get_capture]) for further retrieval.
@@ -26935,7 +26983,6 @@ This method controls whether the position between two cached points is interpola
 			<return type="String">
 			</return>
 			<argument index="0" name="capture" type="int">
-			The number of the captured group, starting with 0. Like other regular expression engines, Godot's engine takes 0 as the full expression, and 1 as the first pair of capturing parentheses.
 			</argument>
 			<description>
 			Returns a captured group. A captured group is the part of a string that matches a part of the pattern delimited by parentheses (unless they are non-capturing parentheses [i](?:)[/i]).
@@ -26943,7 +26990,6 @@ This method controls whether the position between two cached points is interpola
 		</method>
 		<method name="get_captures" qualifiers="const">
 			<return type="StringArray">
-			A list contining all the strings captured by the regular expression.
 			</return>
 			<description>
 			Return a list of all the captures made by the regular expression.
@@ -30675,8 +30721,6 @@ This method controls whether the position between two cached points is interpola
 			</description>
 		</method>
 		<method name="collide_and_get_contacts">
-			<return type="Vector2Array">
-			</return>
 			<argument index="0" name="local_xform" type="Matrix32">
 			</argument>
 			<argument index="1" name="with_shape" type="Shape2D">
@@ -30689,8 +30733,6 @@ This method controls whether the position between two cached points is interpola
 			</description>
 		</method>
 		<method name="collide_with_motion_and_get_contacts">
-			<return type="Vector2Array">
-			</return>
 			<argument index="0" name="local_xform" type="Matrix32">
 			</argument>
 			<argument index="1" name="local_motion" type="Vector2">
@@ -34025,15 +34067,17 @@ This method controls whether the position between two cached points is interpola
 		<method name="cursor_set_column">
 			<argument index="0" name="column" type="int">
 			</argument>
+			<argument index="1" name="arg1" type="bool">
+			</argument>
 			<description>
-			Set the current column of the text editor.
 			</description>
 		</method>
 		<method name="cursor_set_line">
 			<argument index="0" name="line" type="int">
 			</argument>
+			<argument index="1" name="arg1" type="bool">
+			</argument>
 			<description>
-			Set the current line of the text editor.
 			</description>
 		</method>
 		<method name="cursor_get_column" qualifiers="const">
@@ -36289,6 +36333,18 @@ This method controls whether the position between two cached points is interpola
 			<description>
 			</description>
 		</method>
+		<method name="set_hide_folding">
+			<argument index="0" name="hide" type="bool">
+			</argument>
+			<description>
+			</description>
+		</method>
+		<method name="is_folding_hidden" qualifiers="const">
+			<return type="bool">
+			</return>
+			<description>
+			</description>
+		</method>
 	</methods>
 	<signals>
 		<signal name="item_activated">
@@ -37441,6 +37497,14 @@ This method controls whether the position between two cached points is interpola
 	<description>
 	</description>
 	<methods>
+		<method name="angle">
+			<return type="float">
+			</return>
+			<description>
+			Returns the result of atan2 when called with the Vector's x and y as parameters (Math::atan2(x,y)).
+			Be aware that it therefore returns an angle oriented clockwise with regard to the (0, 1) unit vector, and not an angle oriented counter-clockwise with regard to the (1, 0) unit vector (which would be the typical trigonometric representation of the angle when calling Math::atan2(y,x)).
+			</description>
+		</method>
 		<method name="angle_to">
 			<return type="float">
 			</return>
@@ -37459,13 +37523,6 @@ This method controls whether the position between two cached points is interpola
 			Returns the angle in radians between the line connecting the two points and the x coordinate.
 			</description>
 		</method>
-		<method name="atan2">
-			<return type="float">
-			</return>
-			<description>
-			Returns the result of atan2 when called with the Vector's x and y as parameters.
-			</description>
-		</method>
 		<method name="cubic_interpolate">
 			<return type="Vector2">
 			</return>