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

33
doc/classes/PCKPacker.xml
View File

@ -25,38 +25,27 @@
</tutorials>
<methods>
<method name="add_file">
<return type="int" enum="Error">
</return>
<argument index="0" name="pck_path" type="String">
</argument>
<argument index="1" name="source_path" type="String">
</argument>
<argument index="2" name="encrypt" type="bool" default="false">
</argument>
<return type="int" enum="Error" />
<argument index="0" name="pck_path" type="String" />
<argument index="1" name="source_path" type="String" />
<argument index="2" name="encrypt" type="bool" default="false" />
<description>
Adds the [code]source_path[/code] file to the current PCK package at the [code]pck_path[/code] internal path (should start with [code]res://[/code]).
</description>
</method>
<method name="flush">
<return type="int" enum="Error">
</return>
<argument index="0" name="verbose" type="bool" default="false">
</argument>
<return type="int" enum="Error" />
<argument index="0" name="verbose" type="bool" default="false" />
<description>
Writes the files specified using all [method add_file] calls since the last flush. If [code]verbose[/code] is [code]true[/code], a list of files added will be printed to the console for easier debugging.
</description>
</method>
<method name="pck_start">
<return type="int" enum="Error">
</return>
<argument index="0" name="pck_name" type="String">
</argument>
<argument index="1" name="alignment" type="int" default="0">
</argument>
<argument index="2" name="key" type="String" default="&quot;&quot;">
</argument>
<argument index="3" name="encrypt_directory" type="bool" default="false">
</argument>
<return type="int" enum="Error" />
<argument index="0" name="pck_name" type="String" />
<argument index="1" name="alignment" type="int" default="0" />
<argument index="2" name="key" type="String" default="&quot;&quot;" />
<argument index="3" name="encrypt_directory" type="bool" default="false" />
<description>
Creates a new PCK file with the name [code]pck_name[/code]. The [code].pck[/code] file extension isn't added automatically, so it should be part of [code]pck_name[/code] (even though it's not required).
</description>