From e038aeb8bbad8f81b1ca573402ef2fede4aa388c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Simon=20St=C3=BCrz?= <stuerz.simon@gmail.com>
Date: Wed, 18 May 2016 10:16:44 +0200
Subject: [PATCH] complete settings docs

---
 libguh/guhsettings.cpp | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/libguh/guhsettings.cpp b/libguh/guhsettings.cpp
index 7d8660cc..5ac924ce 100644
--- a/libguh/guhsettings.cpp
+++ b/libguh/guhsettings.cpp
@@ -209,21 +209,26 @@ QStringList GuhSettings::allKeys() const
     return m_settings->allKeys();
 }
 
+/*! Adds \a prefix to the current group and starts writing an array of size size. If size is -1 (the default),
+ * it is automatically determined based on the indexes of the entries written. */
 void GuhSettings::beginWriteArray(const QString &prefix)
 {
     m_settings->beginWriteArray(prefix);
 }
 
+/*! Sets the current array index to \a i. */
 void GuhSettings::setArrayIndex(int i)
 {
     m_settings->setArrayIndex(i);
 }
 
+/*! Adds \a prefix to the current group and starts reading from an array. Returns the size of the array.*/
 int GuhSettings::beginReadArray(const QString &prefix)
 {
     return m_settings->beginReadArray(prefix);
 }
 
+/*! End an array. */
 void GuhSettings::endArray()
 {
     m_settings->endArray();