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

24
doc/classes/MainLoop.xml
View File

@@ -45,34 +45,28 @@
</tutorials>
<methods>
<method name="_finalize" qualifiers="virtual">
<return type="void">
</return>
<return type="void" />
<description>
Called before the program exits.
</description>
</method>
<method name="_initialize" qualifiers="virtual">
<return type="void">
</return>
<return type="void" />
<description>
Called once during initialization.
</description>
</method>
<method name="_physics_process" qualifiers="virtual">
<return type="bool">
</return>
<argument index="0" name="delta" type="float">
</argument>
<return type="bool" />
<argument index="0" name="delta" type="float" />
<description>
Called each physics frame with the time since the last physics frame as argument ([code]delta[/code], in seconds). Equivalent to [method Node._physics_process].
If implemented, the method must return a boolean value. [code]true[/code] ends the main loop, while [code]false[/code] lets it proceed to the next frame.
</description>
</method>
<method name="_process" qualifiers="virtual">
<return type="bool">
</return>
<argument index="0" name="delta" type="float">
</argument>
<return type="bool" />
<argument index="0" name="delta" type="float" />
<description>
Called each process (idle) frame with the time since the last process frame as argument (in seconds). Equivalent to [method Node._process].
If implemented, the method must return a boolean value. [code]true[/code] ends the main loop, while [code]false[/code] lets it proceed to the next frame.
@@ -81,10 +75,8 @@
</methods>
<signals>
<signal name="on_request_permissions_result">
<argument index="0" name="permission" type="String">
</argument>
<argument index="1" name="granted" type="bool">
</argument>
<argument index="0" name="permission" type="String" />
<argument index="1" name="granted" type="bool" />
<description>
Emitted when a user responds to a permission request.
</description>