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.
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

View file

@ -10,65 +10,48 @@
</tutorials>
<methods>
<method name="get_expand_margin_size" 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 expand margin size of the specified [enum Side].
</description>
</method>
<method name="get_margin_size" 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 margin size of 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>
</method>
<method name="set_expand_margin_size">
<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_margin_size">
<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 margin to [code]size[/code] pixels for the specified [enum Side].
</description>