diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2021-07-30 15:28:05 +0200 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2021-07-30 15:29:52 +0200 |
| commit | 7adf4cc9b5de6701a41e27690a69b9892d5eed85 (patch) | |
| tree | 0019e6d1b7cd993b81d5bba268074cfc4e10a213 /doc/classes/Line2D.xml | |
| parent | a1c19b9a1e53f78c75c13cb418270db80057b21a (diff) | |
| download | redot-engine-7adf4cc9b5de6701a41e27690a69b9892d5eed85.tar.gz | |
doc: Use self-closing tags for `return` and `argument`
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
Diffstat (limited to 'doc/classes/Line2D.xml')
| -rw-r--r-- | doc/classes/Line2D.xml | 36 |
1 files changed, 12 insertions, 24 deletions
diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml index 587d5833b9..093ba51755 100644 --- a/doc/classes/Line2D.xml +++ b/doc/classes/Line2D.xml @@ -12,56 +12,44 @@ </tutorials> <methods> <method name="add_point"> - <return type="void"> - </return> - <argument index="0" name="position" type="Vector2"> - </argument> - <argument index="1" name="at_position" type="int" default="-1"> - </argument> + <return type="void" /> + <argument index="0" name="position" type="Vector2" /> + <argument index="1" name="at_position" type="int" default="-1" /> <description> Adds a point at the [code]position[/code]. Appends the point at the end of the line. If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position < 0[/code] or [code]at_position >= [method get_point_count][/code]), the point will be appended at the end of the point list. </description> </method> <method name="clear_points"> - <return type="void"> - </return> + <return type="void" /> <description> Removes all points from the line. </description> </method> <method name="get_point_count" qualifiers="const"> - <return type="int"> - </return> + <return type="int" /> <description> Returns the Line2D's amount of points. </description> </method> <method name="get_point_position" qualifiers="const"> - <return type="Vector2"> - </return> - <argument index="0" name="i" type="int"> - </argument> + <return type="Vector2" /> + <argument index="0" name="i" type="int" /> <description> Returns point [code]i[/code]'s position. </description> </method> <method name="remove_point"> - <return type="void"> - </return> - <argument index="0" name="i" type="int"> - </argument> + <return type="void" /> + <argument index="0" name="i" type="int" /> <description> Removes the point at index [code]i[/code] from the line. </description> </method> <method name="set_point_position"> - <return type="void"> - </return> - <argument index="0" name="i" type="int"> - </argument> - <argument index="1" name="position" type="Vector2"> - </argument> + <return type="void" /> + <argument index="0" name="i" type="int" /> + <argument index="1" name="position" type="Vector2" /> <description> Overwrites the position in point [code]i[/code] with the supplied [code]position[/code]. </description> |