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

15
doc/classes/Decal.xml
View File

@ -12,10 +12,8 @@
</tutorials>
<methods>
<method name="get_texture" qualifiers="const">
<return type="Texture2D">
</return>
<argument index="0" name="type" type="int" enum="Decal.DecalTexture">
</argument>
<return type="Texture2D" />
<argument index="0" name="type" type="int" enum="Decal.DecalTexture" />
<description>
Returns the [Texture2D] associated with the specified [enum DecalTexture]. This is a convenience method, in most cases you should access the texture directly.
For example, instead of [code]albedo_tex = $Decal.get_texture(Decal.TEXTURE_ALBEDO)[/code], use [code]albedo_tex = $Decal.texture_albedo[/code].
@ -35,12 +33,9 @@
</description>
</method>
<method name="set_texture">
<return type="void">
</return>
<argument index="0" name="type" type="int" enum="Decal.DecalTexture">
</argument>
<argument index="1" name="texture" type="Texture2D">
</argument>
<return type="void" />
<argument index="0" name="type" type="int" enum="Decal.DecalTexture" />
<argument index="1" name="texture" type="Texture2D" />
<description>
Sets the [Texture2D] associated with the specified [enum DecalTexture]. This is a convenience method, in most cases you should access the texture directly.
For example, instead of [code]$Decal.set_texture(Decal.TEXTURE_ALBEDO, albedo_tex)[/code], use [code]$Decal.texture_albedo = albedo_tex[/code].