summaryrefslogtreecommitdiff
path: root/doc/classes/ConfigFile.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/ConfigFile.xml')
-rw-r--r--doc/classes/ConfigFile.xml58
1 files changed, 29 insertions, 29 deletions
diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml
index b766981f1e..d3ad4e6e4b 100644
--- a/doc/classes/ConfigFile.xml
+++ b/doc/classes/ConfigFile.xml
@@ -100,22 +100,22 @@
</method>
<method name="erase_section">
<return type="void" />
- <argument index="0" name="section" type="String" />
+ <param 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" />
- <argument index="0" name="section" type="String" />
- <argument index="1" name="key" type="String" />
+ <param index="0" name="section" type="String" />
+ <param 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="PackedStringArray" />
- <argument index="0" name="section" type="String" />
+ <param 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>
@@ -128,24 +128,24 @@
</method>
<method name="get_value" qualifiers="const">
<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" />
+ <param index="0" name="section" type="String" />
+ <param index="1" name="key" type="String" />
+ <param 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.
+ 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 [param default] value. If [param default] 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" />
- <argument index="0" name="section" type="String" />
+ <param 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" />
- <argument index="0" name="section" type="String" />
- <argument index="1" name="key" type="String" />
+ <param index="0" name="section" type="String" />
+ <param index="1" name="key" type="String" />
<description>
Returns [code]true[/code] if the specified section-key pair exists.
</description>
@@ -154,7 +154,7 @@
<return type="int" enum="Error" />
<returns_error number="0"/>
<returns_error number="12"/>
- <argument index="0" name="path" type="String" />
+ <param 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).
@@ -162,25 +162,25 @@
</method>
<method name="load_encrypted">
<return type="int" enum="Error" />
- <argument index="0" name="path" type="String" />
- <argument index="1" name="key" type="PackedByteArray" />
+ <param index="0" name="path" type="String" />
+ <param index="1" name="key" type="PackedByteArray" />
<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.
+ Loads the encrypted config file specified as a parameter, using the provided [param key] 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" />
- <argument index="0" name="path" type="String" />
- <argument index="1" name="password" type="String" />
+ <param index="0" name="path" type="String" />
+ <param 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.
+ Loads the encrypted config file specified as a parameter, using the provided [param password] 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" />
- <argument index="0" name="data" type="String" />
+ <param 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).
@@ -188,7 +188,7 @@
</method>
<method name="save">
<return type="int" enum="Error" />
- <argument index="0" name="path" type="String" />
+ <param 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).
@@ -196,27 +196,27 @@
</method>
<method name="save_encrypted">
<return type="int" enum="Error" />
- <argument index="0" name="path" type="String" />
- <argument index="1" name="key" type="PackedByteArray" />
+ <param index="0" name="path" type="String" />
+ <param index="1" name="key" type="PackedByteArray" />
<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.
+ Saves the contents of the [ConfigFile] object to the AES-256 encrypted file specified as a parameter, using the provided [param key] 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" />
- <argument index="0" name="path" type="String" />
- <argument index="1" name="password" type="String" />
+ <param index="0" name="path" type="String" />
+ <param 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.
+ Saves the contents of the [ConfigFile] object to the AES-256 encrypted file specified as a parameter, using the provided [param password] 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" />
- <argument index="0" name="section" type="String" />
- <argument index="1" name="key" type="String" />
- <argument index="2" name="value" type="Variant" />
+ <param index="0" name="section" type="String" />
+ <param index="1" name="key" type="String" />
+ <param 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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-15 13:55:29 +0000