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

6
doc/classes/RichTextEffect.xml
View File

@ -24,10 +24,8 @@
</tutorials>
<methods>
<method name="_process_custom_fx" qualifiers="virtual">
<return type="bool">
</return>
<argument index="0" name="char_fx" type="CharFXTransform">
</argument>
<return type="bool" />
<argument index="0" name="char_fx" type="CharFXTransform" />
<description>
Override this method to modify properties in [code]char_fx[/code]. The method must return [code]true[/code] if the character could be transformed successfully. If the method returns [code]false[/code], it will skip transformation to avoid displaying broken text.
</description>