diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2019-12-07 00:11:17 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-12-07 00:11:17 +0100 |
| commit | 07a739e7e15fdc0d7ed878f0cb465bb93c4e50aa (patch) | |
| tree | d811b713f916bcd4d96c39fed00762311737d989 /doc/classes/ConfigFile.xml | |
| parent | 643b37aaf01138af8e5780caa938a107f2341412 (diff) | |
| parent | 4eff13d7685752246ca311a2fdcc9d6e6eb7f63e (diff) | |
| download | redot-engine-07a739e7e15fdc0d7ed878f0cb465bb93c4e50aa.tar.gz | |
Merge pull request #34159 from akien-mga/doc-enums-constants
doc: Markup fixes for enums and constants
Diffstat (limited to 'doc/classes/ConfigFile.xml')
| -rw-r--r-- | doc/classes/ConfigFile.xml | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml index 56f54e4434..d99f90d09a 100644 --- a/doc/classes/ConfigFile.xml +++ b/doc/classes/ConfigFile.xml @@ -104,7 +104,8 @@ <argument index="0" name="path" type="String"> </argument> <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 [constant OK], [constant FAILED] or [code]ERR_*[/code] constants listed in [@GlobalScope]. If the load was successful, the return value is [constant OK]. + 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). </description> </method> <method name="load_encrypted"> @@ -133,7 +134,8 @@ <argument index="0" name="path" type="String"> </argument> <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 [constant OK], [constant FAILED] or [code]ERR_*[/code] constants listed in [@GlobalScope]. If the load was successful, the return value is [constant OK]. + 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). </description> </method> <method name="save_encrypted"> |