seedlingattempt/godot
1
0
Fork 0
Code Issues Pull Requests Actions 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.
This commit is contained in:
Rémi Verschelde
2021-07-30 15:28:05 +02:00
parent a1c19b9a1e
commit 7adf4cc9b5
408 changed files with 14025 additions and 28050 deletions
Download Patch File Download Diff File Expand all files Collapse all files

96
doc/classes/StyleBoxFlat.xml
View File

@ -25,125 +25,93 @@
</tutorials>
<methods>
<method name="get_border_width" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<return type="int" />
<argument index="0" name="margin" type="int" enum="Side" />
<description>
Returns the specified [enum Side]'s border width.
</description>
</method>
<method name="get_border_width_min" qualifiers="const">
<return type="int">
</return>
<return type="int" />
<description>
Returns the smallest border width out of all four borders.
</description>
</method>
<method name="get_corner_radius" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="corner" type="int" enum="Corner">
</argument>
<return type="int" />
<argument index="0" name="corner" type="int" enum="Corner" />
<description>
Returns the given [code]corner[/code]'s radius. See [enum Corner] for possible values.
</description>
</method>
<method name="get_expand_margin" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<return type="float" />
<argument index="0" name="margin" type="int" enum="Side" />
<description>
Returns the size of the specified [enum Side]'s expand margin.
</description>
</method>
<method name="set_border_width">
<return type="void">
</return>
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<argument index="1" name="width" type="int">
</argument>
<return type="void" />
<argument index="0" name="margin" type="int" enum="Side" />
<argument index="1" name="width" type="int" />
<description>
Sets the specified [enum Side]'s border width to [code]width[/code] pixels.
</description>
</method>
<method name="set_border_width_all">
<return type="void">
</return>
<argument index="0" name="width" type="int">
</argument>
<return type="void" />
<argument index="0" name="width" type="int" />
<description>
Sets the border width to [code]width[/code] pixels for all sides.
</description>
</method>
<method name="set_corner_radius">
<return type="void">
</return>
<argument index="0" name="corner" type="int" enum="Corner">
</argument>
<argument index="1" name="radius" type="int">
</argument>
<return type="void" />
<argument index="0" name="corner" type="int" enum="Corner" />
<argument index="1" name="radius" type="int" />
<description>
Sets the corner radius to [code]radius[/code] pixels for the given [code]corner[/code]. See [enum Corner] for possible values.
</description>
</method>
<method name="set_corner_radius_all">
<return type="void">
</return>
<argument index="0" name="radius" type="int">
</argument>
<return type="void" />
<argument index="0" name="radius" type="int" />
<description>
Sets the corner radius to [code]radius[/code] pixels for all corners.
</description>
</method>
<method name="set_corner_radius_individual">
<return type="void">
</return>
<argument index="0" name="radius_top_left" type="int">
</argument>
<argument index="1" name="radius_top_right" type="int">
</argument>
<argument index="2" name="radius_bottom_right" type="int">
</argument>
<argument index="3" name="radius_bottom_left" type="int">
</argument>
<return type="void" />
<argument index="0" name="radius_top_left" type="int" />
<argument index="1" name="radius_top_right" type="int" />
<argument index="2" name="radius_bottom_right" type="int" />
<argument index="3" name="radius_bottom_left" type="int" />
<description>
Sets the corner radius for each corner to [code]radius_top_left[/code], [code]radius_top_right[/code], [code]radius_bottom_right[/code], and [code]radius_bottom_left[/code] pixels.
</description>
</method>
<method name="set_expand_margin">
<return type="void">
</return>
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<argument index="1" name="size" type="float">
</argument>
<return type="void" />
<argument index="0" name="margin" type="int" enum="Side" />
<argument index="1" name="size" type="float" />
<description>
Sets the expand margin to [code]size[/code] pixels for the specified [enum Side].
</description>
</method>
<method name="set_expand_margin_all">
<return type="void">
</return>
<argument index="0" name="size" type="float">
</argument>
<return type="void" />
<argument index="0" name="size" type="float" />
<description>
Sets the expand margin to [code]size[/code] pixels for all margins.
</description>
</method>
<method name="set_expand_margin_individual">
<return type="void">
</return>
<argument index="0" name="size_left" type="float">
</argument>
<argument index="1" name="size_top" type="float">
</argument>
<argument index="2" name="size_right" type="float">
</argument>
<argument index="3" name="size_bottom" type="float">
</argument>
<return type="void" />
<argument index="0" name="size_left" type="float" />
<argument index="1" name="size_top" type="float" />
<argument index="2" name="size_right" type="float" />
<argument index="3" name="size_bottom" type="float" />
<description>
Sets the expand margin for each margin to [code]size_left[/code], [code]size_top[/code], [code]size_right[/code], and [code]size_bottom[/code] pixels.
</description>