mirror of
https://github.com/godotengine/godot.git
synced 2026-01-03 18:11:19 +03:00
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.
(cherry picked from commit 7adf4cc9b5)
This commit is contained in:
Rémi Verschelde
@@ -32,167 +32,127 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="clear">
|
||||
<return type="void">
|
||||
</return>
|
||||
<return type="void" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="erase_section">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="section" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="section" type="String" />
|
||||
<description>
|
||||
Deletes the specified section along with all the key-value pairs inside. Raises an error if the section does not exist.
|
||||
</description>
|
||||
</method>
|
||||
<method name="erase_section_key">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="section" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="key" type="String">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="section" type="String" />
|
||||
<argument index="1" name="key" type="String" />
|
||||
<description>
|
||||
Deletes the specified key in a section. Raises an error if either the section or the key do not exist.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_section_keys" qualifiers="const">
|
||||
<return type="PoolStringArray">
|
||||
</return>
|
||||
<argument index="0" name="section" type="String">
|
||||
</argument>
|
||||
<return type="PoolStringArray" />
|
||||
<argument index="0" name="section" type="String" />
|
||||
<description>
|
||||
Returns an array of all defined key identifiers in the specified section. Raises an error and returns an empty array if the section does not exist.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_sections" qualifiers="const">
|
||||
<return type="PoolStringArray">
|
||||
</return>
|
||||
<return type="PoolStringArray" />
|
||||
<description>
|
||||
Returns an array of all defined section identifiers.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_value" qualifiers="const">
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<argument index="0" name="section" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="key" type="String">
|
||||
</argument>
|
||||
<argument index="2" name="default" type="Variant" default="null">
|
||||
</argument>
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="section" type="String" />
|
||||
<argument index="1" name="key" type="String" />
|
||||
<argument index="2" name="default" type="Variant" default="null" />
|
||||
<description>
|
||||
Returns the current value for the specified section and key. If either the section or the key do not exist, the method returns the fallback [code]default[/code] value. If [code]default[/code] is not specified or set to [code]null[/code], an error is also raised.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_section" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="section" type="String">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="section" type="String" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the specified section exists.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_section_key" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="section" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="key" type="String">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="section" type="String" />
|
||||
<argument index="1" name="key" type="String" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the specified section-key pair exists.
|
||||
</description>
|
||||
</method>
|
||||
<method name="load">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<argument index="0" name="path" type="String">
|
||||
</argument>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<description>
|
||||
Loads the config file specified as a parameter. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on.
|
||||
Returns one of the [enum Error] code constants ([code]OK[/code] on success).
|
||||
</description>
|
||||
</method>
|
||||
<method name="load_encrypted">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<argument index="0" name="path" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="key" type="PoolByteArray">
|
||||
</argument>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<argument index="1" name="key" type="PoolByteArray" />
|
||||
<description>
|
||||
Loads the encrypted config file specified as a parameter, using the provided [code]key[/code] to decrypt it. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on.
|
||||
Returns one of the [enum Error] code constants ([code]OK[/code] on success).
|
||||
</description>
|
||||
</method>
|
||||
<method name="load_encrypted_pass">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<argument index="0" name="path" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="password" type="String">
|
||||
</argument>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<argument index="1" name="password" type="String" />
|
||||
<description>
|
||||
Loads the encrypted config file specified as a parameter, using the provided [code]password[/code] to decrypt it. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on.
|
||||
Returns one of the [enum Error] code constants ([code]OK[/code] on success).
|
||||
</description>
|
||||
</method>
|
||||
<method name="parse">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<argument index="0" name="data" type="String">
|
||||
</argument>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="data" type="String" />
|
||||
<description>
|
||||
Parses the passed string as the contents of a config file. The string is parsed and loaded in the ConfigFile object which the method was called on.
|
||||
Returns one of the [enum Error] code constants ([code]OK[/code] on success).
|
||||
</description>
|
||||
</method>
|
||||
<method name="save">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<argument index="0" name="path" type="String">
|
||||
</argument>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<description>
|
||||
Saves the contents of the [ConfigFile] object to the file specified as a parameter. The output file uses an INI-style structure.
|
||||
Returns one of the [enum Error] code constants ([code]OK[/code] on success).
|
||||
</description>
|
||||
</method>
|
||||
<method name="save_encrypted">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<argument index="0" name="path" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="key" type="PoolByteArray">
|
||||
</argument>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<argument index="1" name="key" type="PoolByteArray" />
|
||||
<description>
|
||||
Saves the contents of the [ConfigFile] object to the AES-256 encrypted file specified as a parameter, using the provided [code]key[/code] to encrypt it. The output file uses an INI-style structure.
|
||||
Returns one of the [enum Error] code constants ([code]OK[/code] on success).
|
||||
</description>
|
||||
</method>
|
||||
<method name="save_encrypted_pass">
|
||||
<return type="int" enum="Error">
|
||||
</return>
|
||||
<argument index="0" name="path" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="password" type="String">
|
||||
</argument>
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<argument index="1" name="password" type="String" />
|
||||
<description>
|
||||
Saves the contents of the [ConfigFile] object to the AES-256 encrypted file specified as a parameter, using the provided [code]password[/code] to encrypt it. The output file uses an INI-style structure.
|
||||
Returns one of the [enum Error] code constants ([code]OK[/code] on success).
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_value">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="section" type="String">
|
||||
</argument>
|
||||
<argument index="1" name="key" type="String">
|
||||
</argument>
|
||||
<argument index="2" name="value" type="Variant">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="section" type="String" />
|
||||
<argument index="1" name="key" type="String" />
|
||||
<argument index="2" name="value" type="Variant" />
|
||||
<description>
|
||||
Assigns a value to the specified key of the specified section. If either the section or the key do not exist, they are created. Passing a [code]null[/code] value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed.
|
||||
</description>
|
||||
|
||||
Reference in New Issue
Block a user