From 17011f5d123879eb9fcd4ea25b92365f7d2061f7 Mon Sep 17 00:00:00 2001
From: Unknown <real.xgor@hotmail.com>
Date: Mon, 2 Oct 2017 00:12:14 +0200
Subject: [PATCH] Added documenation for Line2D

[ci skip]
---
 doc/classes/Line2D.xml | 26 ++++++++++++++++++++++++--
 1 file changed, 24 insertions(+), 2 deletions(-)

diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml
index e6e615ccf15..3cca256a5dd 100644
--- a/doc/classes/Line2D.xml
+++ b/doc/classes/Line2D.xml
@@ -17,7 +17,7 @@
 			<argument index="0" name="position" type="Vector2">
 			</argument>
 			<description>
-				Add a point at the x/y position in the supplied [Vector2]
+				Add a point at the [code]position[/code]. Appends the point at the end of the line.
 			</description>
 		</method>
 		<method name="get_begin_cap_mode" qualifiers="const">
@@ -54,6 +54,7 @@
 			<return type="int">
 			</return>
 			<description>
+				Returns the Line2D's amount of points.
 			</description>
 		</method>
 		<method name="get_point_position" qualifiers="const">
@@ -62,6 +63,7 @@
 			<argument index="0" name="i" type="int">
 			</argument>
 			<description>
+				Returns point [code]i[code]'s position.
 			</description>
 		</method>
 		<method name="get_points" qualifiers="const">
@@ -106,7 +108,7 @@
 			<argument index="0" name="i" type="int">
 			</argument>
 			<description>
-				Remove the point at index 'i' from the line.
+				Remove the point at index [code]i[/code] from the line.
 			</description>
 		</method>
 		<method name="set_begin_cap_mode">
@@ -157,6 +159,7 @@
 			<argument index="1" name="position" type="Vector2">
 			</argument>
 			<description>
+				Overwites the position in point [code]i[/code] with the supplied [code]position[/code].
 			</description>
 		</method>
 		<method name="set_points">
@@ -210,44 +213,63 @@
 	</methods>
 	<members>
 		<member name="begin_cap_mode" type="int" setter="set_begin_cap_mode" getter="get_begin_cap_mode" enum="Line2D.LineCapMode">
+			Controls the style of the line's first point. Use [code]LINE_CAP_*[/code] constants. Default value: [code]LINE_CAP_NONE[/code].
 		</member>
 		<member name="default_color" type="Color" setter="set_default_color" getter="get_default_color">
+			The line's color. Will not be used if a gradient is set.
 		</member>
 		<member name="end_cap_mode" type="int" setter="set_end_cap_mode" getter="get_end_cap_mode" enum="Line2D.LineCapMode">
+			Controls the style of the line's last point. Use [code]LINE_CAP_*[/code] constants. Default value: [code]LINE_CAP_NONE[/code].
 		</member>
 		<member name="gradient" type="Gradient" setter="set_gradient" getter="get_gradient">
+			The gradient is drawn through the whole line from start to finish. The default color will not be used if a gradient is set.
 		</member>
 		<member name="joint_mode" type="int" setter="set_joint_mode" getter="get_joint_mode" enum="Line2D.LineJointMode">
+			The style for the points inbetween the start and the end.
 		</member>
 		<member name="points" type="PoolVector2Array" setter="set_points" getter="get_points">
+			The points that form the lines. The line is drawn between every point set in this array.
 		</member>
 		<member name="round_precision" type="int" setter="set_round_precision" getter="get_round_precision">
+			The smoothness of the rounded joints and caps. This is only used if a cap or joint is set as round.
 		</member>
 		<member name="sharp_limit" type="float" setter="set_sharp_limit" getter="get_sharp_limit">
+			The direction difference in radians between vector points. This value is only used if [code]joint mode[/code] is set to [code]LINE_JOINT_SHARP[/code].
 		</member>
 		<member name="texture" type="Texture" setter="set_texture" getter="get_texture">
+			The texture used for the line's texture. Uses [code]texture_mode[/code] for drawing style.
 		</member>
 		<member name="texture_mode" type="int" setter="set_texture_mode" getter="get_texture_mode" enum="Line2D.LineTextureMode">
+			The style to render the [code]texture[/code] on the line. Use [code]LINE_TEXTURE_*[/code] constants. Default value: [code]LINE_TEXTURE_NONE[/code].
 		</member>
 		<member name="width" type="float" setter="set_width" getter="get_width">
+			The line's width.
 		</member>
 	</members>
 	<constants>
 		<constant name="LINE_JOINT_SHARP" value="0">
+			The line's joints will be pointy. If [code]sharp_limit[/code] is greater than the rotation of a joint, it becomes a bevel joint instead.
 		</constant>
 		<constant name="LINE_JOINT_BEVEL" value="1">
+			The line's joints will be bevelled/chamfered.
 		</constant>
 		<constant name="LINE_JOINT_ROUND" value="2">
+			The line's joints will be rounded.
 		</constant>
 		<constant name="LINE_CAP_NONE" value="0">
+			Don't have a line cap.
 		</constant>
 		<constant name="LINE_CAP_BOX" value="1">
+			Draws the line cap as a box.
 		</constant>
 		<constant name="LINE_CAP_ROUND" value="2">
+			Draws the line cap as a circle.
 		</constant>
 		<constant name="LINE_TEXTURE_NONE" value="0">
+			Takes the left pixels of the texture and renders it over the whole line.
 		</constant>
 		<constant name="LINE_TEXTURE_TILE" value="1">
+			Tiles the texture over the line. The texture need to be imported with Repeat Enabled for it to work properly.
 		</constant>
 	</constants>
 </class>