hertog/godot-module-template
Template
2
1
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: Use self-closing tags for return and argument

Browse source 
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.
This commit is contained in:
Rémi Verschelde 2021-07-30 15:28:05 +02:00
parent a1c19b9a1e
commit 7adf4cc9b5
No known key found for this signature in database
GPG key ID: C3336907360768E1
408 changed files with 14025 additions and 28050 deletions
Download patch file Download diff file Expand all files Collapse all files

54
doc/classes/Gradient.xml
View file

@ -10,77 +10,59 @@
</tutorials>
<methods>
<method name="add_point">
<return type="void">
</return>
<argument index="0" name="offset" type="float">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<return type="void" />
<argument index="0" name="offset" type="float" />
<argument index="1" name="color" type="Color" />
<description>
Adds the specified color to the end of the gradient, with the specified offset.
</description>
</method>
<method name="get_color">
<return type="Color">
</return>
<argument index="0" name="point" type="int">
</argument>
<return type="Color" />
<argument index="0" name="point" type="int" />
<description>
Returns the color of the gradient color at index [code]point[/code].
</description>
</method>
<method name="get_offset">
<return type="float">
</return>
<argument index="0" name="point" type="int">
</argument>
<return type="float" />
<argument index="0" name="point" type="int" />
<description>
Returns the offset of the gradient color at index [code]point[/code].
</description>
</method>
<method name="get_point_count" qualifiers="const">
<return type="int">
</return>
<return type="int" />
<description>
Returns the number of colors in the gradient.
</description>
</method>
<method name="interpolate">
<return type="Color">
</return>
<argument index="0" name="offset" type="float">
</argument>
<return type="Color" />
<argument index="0" name="offset" type="float" />
<description>
Returns the interpolated color specified by [code]offset[/code].
</description>
</method>
<method name="remove_point">
<return type="void">
</return>
<argument index="0" name="point" type="int">
</argument>
<return type="void" />
<argument index="0" name="point" type="int" />
<description>
Removes the color at the index [code]point[/code].
</description>
</method>
<method name="set_color">
<return type="void">
</return>
<argument index="0" name="point" type="int">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<return type="void" />
<argument index="0" name="point" type="int" />
<argument index="1" name="color" type="Color" />
<description>
Sets the color of the gradient color at index [code]point[/code].
</description>
</method>
<method name="set_offset">
<return type="void">
</return>
<argument index="0" name="point" type="int">
</argument>
<argument index="1" name="offset" type="float">
</argument>
<return type="void" />
<argument index="0" name="point" type="int" />
<argument index="1" name="offset" type="float" />
<description>
Sets the offset for the gradient color at index [code]point[/code].
</description>