godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clarify ConfigFile class methods that return error

Browse Source 
related to #80936
This commit is contained in:
curious-broccoli 2023-08-24 18:16:46 +00:00
parent 75f9c97dea
commit 653a455b58
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/classes/ConfigFile.xml
View File

@ -163,7 +163,7 @@
<param index="0" name="path" type="String" /> <param index="0" name="path" type="String" />
<description> <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. 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 ([constant OK] on success). Returns [constant OK] on success, or one of the other [enum Error] values if the operation failed.
</description> </description>
</method> </method>
<method name="load_encrypted"> <method name="load_encrypted">
@ -172,7 +172,7 @@
<param index="1" name="key" type="PackedByteArray" /> <param index="1" name="key" type="PackedByteArray" />
<description> <description>
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. 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 ([constant OK] on success). Returns [constant OK] on success, or one of the other [enum Error] values if the operation failed.
</description> </description>
</method> </method>
<method name="load_encrypted_pass"> <method name="load_encrypted_pass">
@ -181,7 +181,7 @@
<param index="1" name="password" type="String" /> <param index="1" name="password" type="String" />
<description> <description>
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. 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 ([constant OK] on success). Returns [constant OK] on success, or one of the other [enum Error] values if the operation failed.
</description> </description>
</method> </method>
<method name="parse"> <method name="parse">
@ -189,7 +189,7 @@
<param index="0" name="data" type="String" /> <param index="0" name="data" type="String" />
<description> <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. 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 ([constant OK] on success). Returns [constant OK] on success, or one of the other [enum Error] values if the operation failed.
</description> </description>
</method> </method>
<method name="save"> <method name="save">
@ -197,7 +197,7 @@
<param index="0" name="path" type="String" /> <param index="0" name="path" type="String" />
<description> <description>
Saves the contents of the [ConfigFile] object to the file specified as a parameter. The output file uses an INI-style structure. 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 ([constant OK] on success). Returns [constant OK] on success, or one of the other [enum Error] values if the operation failed.
</description> </description>
</method> </method>
<method name="save_encrypted"> <method name="save_encrypted">
@ -206,7 +206,7 @@
<param index="1" name="key" type="PackedByteArray" /> <param index="1" name="key" type="PackedByteArray" />
<description> <description>
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. 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 ([constant OK] on success). Returns [constant OK] on success, or one of the other [enum Error] values if the operation failed.
</description> </description>
</method> </method>
<method name="save_encrypted_pass"> <method name="save_encrypted_pass">
@ -215,7 +215,7 @@
<param index="1" name="password" type="String" /> <param index="1" name="password" type="String" />
<description> <description>
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. 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 ([constant OK] on success). Returns [constant OK] on success, or one of the other [enum Error] values if the operation failed.
</description> </description>
</method> </method>
<method name="set_value"> <method name="set_value">