diff options
| author | curious-broccoli <77789413+curious-broccoli@users.noreply.github.com> | 2023-08-24 18:16:46 +0000 |
|---|---|---|
| committer | curious-broccoli <77789413+curious-broccoli@users.noreply.github.com> | 2023-08-24 18:16:46 +0000 |
| commit | 653a455b58299ebbfdfbd8da3a5dcf8911f25cb5 (patch) | |
| tree | 804aa4eda91b14b31c2e15ef7ea55c11278750f2 | |
| parent | 75f9c97deaa8378477441e07ea1782ecab6d2eca (diff) | |
| download | redot-engine-653a455b58299ebbfdfbd8da3a5dcf8911f25cb5.tar.gz | |
Clarify ConfigFile class methods that return error
related to #80936
| -rw-r--r-- | doc/classes/ConfigFile.xml | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml index 04e4164415..e6b28ae98e 100644 --- a/doc/classes/ConfigFile.xml +++ b/doc/classes/ConfigFile.xml @@ -163,7 +163,7 @@ <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 ([constant OK] on success). + Returns [constant OK] on success, or one of the other [enum Error] values if the operation failed. </description> </method> <method name="load_encrypted"> @@ -172,7 +172,7 @@ <param index="1" name="key" type="PackedByteArray" /> <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. - 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> </method> <method name="load_encrypted_pass"> @@ -181,7 +181,7 @@ <param index="1" name="password" type="String" /> <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. - 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> </method> <method name="parse"> @@ -189,7 +189,7 @@ <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 ([constant OK] on success). + Returns [constant OK] on success, or one of the other [enum Error] values if the operation failed. </description> </method> <method name="save"> @@ -197,7 +197,7 @@ <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 ([constant OK] on success). + Returns [constant OK] on success, or one of the other [enum Error] values if the operation failed. </description> </method> <method name="save_encrypted"> @@ -206,7 +206,7 @@ <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 [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> </method> <method name="save_encrypted_pass"> @@ -215,7 +215,7 @@ <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 [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> </method> <method name="set_value"> |