From fff0e7b8e204bf13c7e8c1cd9e61eded9ccc0891 Mon Sep 17 00:00:00 2001
From: Yuri Sizov <yuris@humnom.net>
Date: Mon, 15 Aug 2022 17:31:23 +0300
Subject: Clarify the Line2D, Curve2D/3D documentation and fix parameter names

---
 doc/classes/Curve2D.xml |  6 +++---
 doc/classes/Curve3D.xml |  6 +++---
 doc/classes/Line2D.xml  | 20 ++++++++++----------
 3 files changed, 16 insertions(+), 16 deletions(-)

(limited to 'doc/classes')

diff --git a/doc/classes/Curve2D.xml b/doc/classes/Curve2D.xml
index 01a011021f..f15c0d74ca 100644
--- a/doc/classes/Curve2D.xml
+++ b/doc/classes/Curve2D.xml
@@ -15,10 +15,10 @@
 			<param index="0" name="position" type="Vector2" />
 			<param index="1" name="in" type="Vector2" default="Vector2(0, 0)" />
 			<param index="2" name="out" type="Vector2" default="Vector2(0, 0)" />
-			<param index="3" name="at_position" type="int" default="-1" />
+			<param index="3" name="index" type="int" default="-1" />
 			<description>
-				Adds a point to a curve at [param position] relative to the [Curve2D]'s position, with control points [param in] and [param out].
-				If [param at_position] is given, the point is inserted before the point number [param at_position], moving that point (and every point after) after the inserted point. If [param at_position] is not given, or is an illegal value ([code]at_position &lt;0[/code] or [code]at_position &gt;= [method get_point_count][/code]), the point will be appended at the end of the point list.
+				Adds a point with the specified [param position] relative to the curve's own position, with control points [param in] and [param out]. Appends the new point at the end of the point list.
+				If [param index] is given, the new point is inserted before the existing point identified by index [param index]. Every existing point starting from [param index] is shifted further down the list of points. The index must be greater than or equal to [code]0[/code] and must not exceed the number of existing points in the line. See [member point_count].
 			</description>
 		</method>
 		<method name="clear_points">
diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml
index ca3ce1cb64..0843453820 100644
--- a/doc/classes/Curve3D.xml
+++ b/doc/classes/Curve3D.xml
@@ -15,10 +15,10 @@
 			<param index="0" name="position" type="Vector3" />
 			<param index="1" name="in" type="Vector3" default="Vector3(0, 0, 0)" />
 			<param index="2" name="out" type="Vector3" default="Vector3(0, 0, 0)" />
-			<param index="3" name="at_position" type="int" default="-1" />
+			<param index="3" name="index" type="int" default="-1" />
 			<description>
-				Adds a point to a curve at [param position] relative to the [Curve3D]'s position, with control points [param in] and [param out].
-				If [param at_position] is given, the point is inserted before the point number [param at_position], moving that point (and every point after) after the inserted point. If [param at_position] is not given, or is an illegal value ([code]at_position &lt;0[/code] or [code]at_position &gt;= [method get_point_count][/code]), the point will be appended at the end of the point list.
+				Adds a point with the specified [param position] relative to the curve's own position, with control points [param in] and [param out]. Appends the new point at the end of the point list.
+				If [param index] is given, the new point is inserted before the existing point identified by index [param index]. Every existing point starting from [param index] is shifted further down the list of points. The index must be greater than or equal to [code]0[/code] and must not exceed the number of existing points in the line. See [member point_count].
 			</description>
 		</method>
 		<method name="clear_points">
diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml
index f6aea83b7f..f4bf803554 100644
--- a/doc/classes/Line2D.xml
+++ b/doc/classes/Line2D.xml
@@ -14,10 +14,10 @@
 		<method name="add_point">
 			<return type="void" />
 			<param index="0" name="position" type="Vector2" />
-			<param index="1" name="at_position" type="int" default="-1" />
+			<param index="1" name="index" type="int" default="-1" />
 			<description>
-				Adds a point at the [param position]. Appends the point at the end of the line.
-				If [param at_position] is given, the point is inserted before the point number [param at_position], moving that point (and every point after) after the inserted point. If [param at_position] is not given, or is an illegal value ([code]at_position &lt; 0[/code] or [code]at_position &gt;= [method get_point_count][/code]), the point will be appended at the end of the point list.
+				Adds a point with the specified [param position] relative to the line's own position. Appends the new point at the end of the point list.
+				If [param index] is given, the new point is inserted before the existing point identified by index [param index]. Every existing point starting from [param index] is shifted further down the list of points. The index must be greater than or equal to [code]0[/code] and must not exceed the number of existing points in the line. See [method get_point_count].
 			</description>
 		</method>
 		<method name="clear_points">
@@ -29,29 +29,29 @@
 		<method name="get_point_count" qualifiers="const">
 			<return type="int" />
 			<description>
-				Returns the Line2D's amount of points.
+				Returns the amount of points in the line.
 			</description>
 		</method>
 		<method name="get_point_position" qualifiers="const">
 			<return type="Vector2" />
-			<param index="0" name="i" type="int" />
+			<param index="0" name="index" type="int" />
 			<description>
-				Returns point [param i]'s position.
+				Returns the position of the point at index [param index].
 			</description>
 		</method>
 		<method name="remove_point">
 			<return type="void" />
-			<param index="0" name="i" type="int" />
+			<param index="0" name="index" type="int" />
 			<description>
-				Removes the point at index [param i] from the line.
+				Removes the point at index [param index] from the line.
 			</description>
 		</method>
 		<method name="set_point_position">
 			<return type="void" />
-			<param index="0" name="i" type="int" />
+			<param index="0" name="index" type="int" />
 			<param index="1" name="position" type="Vector2" />
 			<description>
-				Overwrites the position in point [param i] with the supplied [param position].
+				Overwrites the position of the point at index [param index] with the supplied [param position].
 			</description>
 		</method>
 	</methods>
-- 
cgit v1.2.3