summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorPedro J. Estébanez <pedrojrulez@gmail.com>2020-02-10 09:19:00 +0100
committerPedro J. Estébanez <pedrojrulez@gmail.com>2020-02-10 11:12:33 +0100
commite5bd3b707f07d1f3eb4d4a8a18ee1736ff1fbe76 (patch)
tree91788a0636fef7513108e1b4b4e8b8b950dc9096 /doc/classes
parent47f19cc776940469a006aa3f7331166b32d9f7b4 (diff)
Add ConfigFile::parse()
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/ConfigFile.xml10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml
index 7eaa815a87..ad36f1f1c3 100644
--- a/doc/classes/ConfigFile.xml
+++ b/doc/classes/ConfigFile.xml
@@ -129,6 +129,16 @@
<description>
</description>
</method>
+ <method name="parse">
+ <return type="int" enum="Error">
+ </return>
+ <argument index="0" name="data" type="String">
+ </argument>
+ <description>
+ Parses the 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 ([code]OK[/code] on success).
+ </description>
+ </method>
<method name="save">
<return type="int" enum="Error">
</return>