Merge pull request #14646 from willnationsdev/docs4

[DOCS] Animation, CanvasItem, Curve3D, Curve

doc/classes/Animation.xml

@@ -38,6 +38,7 @@
 			<argument index="1" name="to_animation" type="Animation">
 			</argument>
 			<description>
+				Adds a new track that is a copy of the given track from [code]to_animation[/code].
 			</description>
 		</method>
 		<method name="find_track" qualifiers="const">
@@ -260,6 +261,7 @@
 			<argument index="0" name="idx" type="int">
 			</argument>
 			<description>
+				Returns [code]true[/code] if the track at index [code]idx[/code] is enabled.
 			</description>
 		</method>
 		<method name="track_is_imported" qualifiers="const">
@@ -319,6 +321,7 @@
 			<argument index="1" name="enabled" type="bool">
 			</argument>
 			<description>
+				Enables/disables the given track. Tracks are enabled by default.	
 			</description>
 		</method>
 		<method name="track_set_imported">

doc/classes/CanvasItem.xml

@@ -36,7 +36,7 @@
 			<argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )">
 			</argument>
 			<description>
-				Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char.
+				Draws a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char.
 			</description>
 		</method>
 		<method name="draw_circle">
@@ -49,7 +49,7 @@
 			<argument index="2" name="color" type="Color">
 			</argument>
 			<description>
-				Draw a colored circle.
+				Draws a colored circle.
 			</description>
 		</method>
 		<method name="draw_colored_polygon">
@@ -68,7 +68,7 @@
 			<argument index="5" name="antialiased" type="bool" default="false">
 			</argument>
 			<description>
-				Draw a colored polygon of any amount of points, convex or concave.
+				Draws a colored polygon of any amount of points, convex or concave.
 			</description>
 		</method>
 		<method name="draw_line">
@@ -85,7 +85,7 @@
 			<argument index="4" name="antialiased" type="bool" default="false">
 			</argument>
 			<description>
-				Draw a line from a 2D point to another, with a given color and width. It can be optionally antialiased.
+				Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased.
 			</description>
 		</method>
 		<method name="draw_multiline">
@@ -100,6 +100,7 @@
 			<argument index="3" name="antialiased" type="bool" default="false">
 			</argument>
 			<description>
+				Draws multiple, parallel lines with a uniform [code]color[/code] and [code]width[/code] and optional antialiasing.
 			</description>
 		</method>
 		<method name="draw_multiline_colors">
@@ -114,6 +115,7 @@
 			<argument index="3" name="antialiased" type="bool" default="false">
 			</argument>
 			<description>
+				Draws multiple, parallel lines with a uniform [code]width[/code], segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code].
 			</description>
 		</method>
 		<method name="draw_polygon">
@@ -132,7 +134,7 @@
 			<argument index="5" name="antialiased" type="bool" default="false">
 			</argument>
 			<description>
-				Draw a polygon of any amount of points, convex or concave.
+				Draws a polygon of any amount of points, convex or concave.
 			</description>
 		</method>
 		<method name="draw_polyline">
@@ -147,7 +149,7 @@
 			<argument index="3" name="antialiased" type="bool" default="false">
 			</argument>
 			<description>
-				Draw a polyline with a uniform [code]color[/code] and [code]width[/code] and optional antialiasing.
+				Draws interconnected line segments with a uniform [code]color[/code] and [code]width[/code] and optional antialiasing.
 			</description>
 		</method>
 		<method name="draw_polyline_colors">
@@ -162,7 +164,7 @@
 			<argument index="3" name="antialiased" type="bool" default="false">
 			</argument>
 			<description>
-				Draw a polyline with a uniform [code]width[/code], segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code].
+				Draws interconnected line segments with a uniform [code]width[/code], segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code].
 			</description>
 		</method>
 		<method name="draw_primitive">
@@ -181,7 +183,7 @@
 			<argument index="5" name="normal_map" type="Texture" default="null">
 			</argument>
 			<description>
-				Draw a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad.
+				Draws a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad.
 			</description>
 		</method>
 		<method name="draw_rect">
@@ -194,7 +196,7 @@
 			<argument index="2" name="filled" type="bool" default="true">
 			</argument>
 			<description>
-				Draw a colored rectangle.
+				Draws a colored rectangle.
 			</description>
 		</method>
 		<method name="draw_set_transform">
@@ -233,7 +235,7 @@
 			<argument index="4" name="clip_w" type="int" default="-1">
 			</argument>
 			<description>
-				Draw a string using a custom font.
+				Draws a string using a custom font.
 			</description>
 		</method>
 		<method name="draw_style_box">
@@ -244,7 +246,7 @@
 			<argument index="1" name="rect" type="Rect2">
 			</argument>
 			<description>
-				Draw a styled rectangle.
+				Draws a styled rectangle.
 			</description>
 		</method>
 		<method name="draw_texture">
@@ -259,7 +261,7 @@
 			<argument index="3" name="normal_map" type="Texture" default="null">
 			</argument>
 			<description>
-				Draw a texture at a given position.
+				Draws a texture at a given position.
 			</description>
 		</method>
 		<method name="draw_texture_rect">
@@ -278,7 +280,7 @@
 			<argument index="5" name="normal_map" type="Texture" default="null">
 			</argument>
 			<description>
-				Draw a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.
+				Draws a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.
 			</description>
 		</method>
 		<method name="draw_texture_rect_region">
@@ -299,7 +301,7 @@
 			<argument index="6" name="clip_uv" type="bool" default="true">
 			</argument>
 			<description>
-				Draw a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.
+				Draws a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.
 			</description>
 		</method>
 		<method name="get_canvas" qualifiers="const">

doc/classes/Curve.xml

@@ -1,8 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="Curve" inherits="Resource" category="Core" version="3.0-beta">
 	<brief_description>
+		A mathematic curve.
 	</brief_description>
 	<description>
+		A curve that can be saved and re-used for other objects. By default it ranges between [code]0[/code] and [code]1[/code] on the y-axis and positions points relative to the [code]0.5[/code] y-position.
 	</description>
 	<tutorials>
 	</tutorials>
@@ -23,24 +25,28 @@
 			<argument index="4" name="right_mode" type="int" enum="Curve.TangentMode" default="0">
 			</argument>
 			<description>
+				Adds a point to the curve. For each side, if the [code]*_mode[/code] is [code]TANGENT_LINEAR[/code], the [code]*_tangent[/code] angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the [code]*_tangent[/code] angle if [code]*_mode[/code] is set to [code]TANGENT_FREE[/code].
 			</description>
 		</method>
 		<method name="bake">
 			<return type="void">
 			</return>
 			<description>
+				Recomputes the baked cache of points for the curve.
 			</description>
 		</method>
 		<method name="clean_dupes">
 			<return type="void">
 			</return>
 			<description>
+				Removes points that are closer than [code]CMP_EPSILON[/code] (0.00001) units to their neighbor on the curve.
 			</description>
 		</method>
 		<method name="clear_points">
 			<return type="void">
 			</return>
 			<description>
+				Removes all points from the curve.
 			</description>
 		</method>
 		<method name="get_point_left_mode" qualifiers="const">
@@ -49,6 +55,7 @@
 			<argument index="0" name="index" type="int">
 			</argument>
 			<description>
+				Returns the left [code]TangentMode[/code] for the point at [code]index[/code].
 			</description>
 		</method>
 		<method name="get_point_left_tangent" qualifiers="const">
@@ -57,6 +64,7 @@
 			<argument index="0" name="index" type="int">
 			</argument>
 			<description>
+				Returns the left tangent angle (in degrees) for the point at [code]index[/code].
 			</description>
 		</method>
 		<method name="get_point_position" qualifiers="const">
@@ -65,6 +73,7 @@
 			<argument index="0" name="index" type="int">
 			</argument>
 			<description>
+				Returns the curve coordinates for the point at [code]index[/code].
 			</description>
 		</method>
 		<method name="get_point_right_mode" qualifiers="const">
@@ -73,6 +82,7 @@
 			<argument index="0" name="index" type="int">
 			</argument>
 			<description>
+				Returns the right [code]TangentMode[/code] for the point at [code]index[/code].
 			</description>
 		</method>
 		<method name="get_point_right_tangent" qualifiers="const">
@@ -81,6 +91,7 @@
 			<argument index="0" name="index" type="int">
 			</argument>
 			<description>
+				Returns the right tangent angle (in degrees) for the point at [code]index[/code].
 			</description>
 		</method>
 		<method name="interpolate" qualifiers="const">
@@ -89,12 +100,14 @@
 			<argument index="0" name="offset" type="float">
 			</argument>
 			<description>
+				Returns the y value for the point that would exist at x-position [code]offset[/code] along the curve.
 			</description>
 		</method>
 		<method name="interpolate_baked">
 			<return type="float">
 			</return>
 			<argument index="0" name="offset" type="float">
+				Returns the y value for the point that would exist at x-position [code]offset[/code] along the curve using the baked cache. Bakes the curve's points if not already baked.
 			</argument>
 			<description>
 			</description>
@@ -105,6 +118,7 @@
 			<argument index="0" name="index" type="int">
 			</argument>
 			<description>
+				Removes the point at [code]index[/code] from the curve.
 			</description>
 		</method>
 		<method name="set_point_left_mode">
@@ -115,6 +129,7 @@
 			<argument index="1" name="mode" type="int" enum="Curve.TangentMode">
 			</argument>
 			<description>
+				Sets the left [code]TangentMode[/code] for the point at [code]index[/code] to [code]mode[/code].
 			</description>
 		</method>
 		<method name="set_point_left_tangent">
@@ -125,6 +140,7 @@
 			<argument index="1" name="tangent" type="float">
 			</argument>
 			<description>
+				Sets the left tangent angle for the point at [code]index[/code] to [code]tangent[/code].
 			</description>
 		</method>
 		<method name="set_point_offset">
@@ -135,6 +151,7 @@
 			<argument index="1" name="offset" type="float">
 			</argument>
 			<description>
+				Sets the offset from [code]0.5[/code]
 			</description>
 		</method>
 		<method name="set_point_right_mode">
@@ -145,6 +162,7 @@
 			<argument index="1" name="mode" type="int" enum="Curve.TangentMode">
 			</argument>
 			<description>
+				Sets the right [code]TangentMode[/code] for the point at [code]index[/code] to [code]mode[/code].
 			</description>
 		</method>
 		<method name="set_point_right_tangent">
@@ -155,6 +173,7 @@
 			<argument index="1" name="tangent" type="float">
 			</argument>
 			<description>
+				Sets the right tangent angle for the point at [code]index[/code] to [code]tangent[/code].
 			</description>
 		</method>
 		<method name="set_point_value">
@@ -165,29 +184,37 @@
 			<argument index="1" name="y" type="float">
 			</argument>
 			<description>
+				Assigns the vertical position [code]y[/code] to the point at [code]index[/code].
 			</description>
 		</method>
 	</methods>
 	<members>
 		<member name="bake_resolution" type="int" setter="set_bake_resolution" getter="get_bake_resolution">
+			The number of points to include in the baked (i.e. cached) curve data.
 		</member>
 		<member name="max_value" type="float" setter="set_max_value" getter="get_max_value">
+			The maximum value the curve can reach. Default value: [code]1[/code].
 		</member>
 		<member name="min_value" type="float" setter="set_min_value" getter="get_min_value">
+			The minimum value the curve can reach. Default value: [code]0[/code].
 		</member>
 	</members>
 	<signals>
 		<signal name="range_changed">
 			<description>
+				Emitted when [member max_value] or [member min_value] is changed.
 			</description>
 		</signal>
 	</signals>
 	<constants>
 		<constant name="TANGENT_FREE" value="0" enum="TangentMode">
+			The tangent on this side of the point is user-defined.
 		</constant>
 		<constant name="TANGENT_LINEAR" value="1" enum="TangentMode">
+			The curve calculates the tangent on this side of the point as the slope halfway towards the adjacent point.
 		</constant>
 		<constant name="TANGENT_MODE_COUNT" value="2" enum="TangentMode">
+			The total number of available tangent modes.
 		</constant>
 	</constants>
 </class>

doc/classes/Curve3D.xml

@@ -32,6 +32,7 @@
 			<return type="void">
 			</return>
 			<description>
+				Removes all points from the curve.
 			</description>
 		</method>
 		<method name="get_baked_length" qualifiers="const">
@@ -203,6 +204,7 @@
 	</methods>
 	<members>
 		<member name="bake_interval" type="float" setter="set_bake_interval" getter="get_bake_interval">
+			The distance in meters between two adjacent cached points. Changing it forces the cache to be recomputed the next time the [method get_baked_points] or [method get_baked_length] function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care.
 		</member>
 	</members>
 	<constants>