diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml index 04e41644155..e6b28ae98e6 100644 --- a/doc/classes/ConfigFile.xml +++ b/doc/classes/ConfigFile.xml @@ -163,7 +163,7 @@ 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. @@ -172,7 +172,7 @@ 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. @@ -181,7 +181,7 @@ 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. @@ -189,7 +189,7 @@ 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. @@ -197,7 +197,7 @@ 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. @@ -206,7 +206,7 @@ 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. @@ -215,7 +215,7 @@ 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.