godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-03 18:11:19 +03:00
Code Issues Packages Projects Releases Wiki Activity

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.

(cherry picked from commit 7adf4cc9b5)
This commit is contained in:
Rémi Verschelde
2021-07-30 15:28:05 +02:00
parent a43365bd58
commit f5836b40d4
356 changed files with 10841 additions and 21682 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 ramp, 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 ramp 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 ramp 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 ramp.
</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 ramp 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 ramp color at index [code]point[/code].
</description>