Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rephrase ConfigFile class methods error description #80970

Merged
merged 1 commit into from
Sep 29, 2023
Merged

Rephrase ConfigFile class methods error description #80970

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions doc/classes/ConfigFile.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand All @@ -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">
Expand All @@ -181,23 +181,23 @@
<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">
<return type="int" enum="Error" />
<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">
<return type="int" enum="Error" />
<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">
Expand All @@ -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">
Expand All @@ -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">
Expand Down