From 8421b895f5697ebf680c124f84a68dcdea029c62 Mon Sep 17 00:00:00 2001
From: Tobias Markmann <tm@ayena.de>
Date: Mon, 26 Jan 2015 14:44:32 +0100
Subject: Document the less self-explaining setting constants

Test-Information:

None required.

Change-Id: If267201ea28e894a9f79335972b71611b0058912

diff --git a/Swift/Controllers/SettingConstants.h b/Swift/Controllers/SettingConstants.h
index 0ac1734..b441303 100644
--- a/Swift/Controllers/SettingConstants.h
+++ b/Swift/Controllers/SettingConstants.h
@@ -9,26 +9,82 @@
 #include <Swift/Controllers/Settings/SettingsProvider.h>
 
 namespace Swift {
+	/**
+	 *  This class contains the major setting keys for Swift.
+	 */
 	class SettingConstants {
 		public:
+			/**
+			 * The #IDLE_GOES_OFFLINE setting specifies whether to close the XMPP connection when
+			 * the user went idle.
+			 *
+			 * True for automatic close of the XMPP connection and false for only changing the presence on idle.
+			 */
 			static const SettingsProvider::Setting<bool> IDLE_GOES_OFFLINE;
+			/**
+			 * The #IDLE_TIMEOUT setting specifieds the seconds the user has to be inactive at the 
+			 * desktop so the user is regarded as idle.
+			 */
 			static const SettingsProvider::Setting<int> IDLE_TIMEOUT;
 			static const SettingsProvider::Setting<bool> SHOW_NOTIFICATIONS;
+			/**
+			 * The #REQUEST_DELIVERYRECEIPTS settings specifies whether to request delivery receipts
+			 * for messages to contacts that support message receipts.
+			 */
 			static const SettingsProvider::Setting<bool> REQUEST_DELIVERYRECEIPTS;
 			static const SettingsProvider::Setting<bool> FORGET_PASSWORDS;
 			static const SettingsProvider::Setting<bool> REMEMBER_RECENT_CHATS;
 			static const SettingsProvider::Setting<std::string> LAST_LOGIN_JID;
 			static const SettingsProvider::Setting<bool> LOGIN_AUTOMATICALLY;
+			/**
+			 * The #SHOW_OFFLINE setting specifies whether or not to show offline contacts in the 
+			 * roster.
+			 *
+			 * If set true Swift will show offline contacts; else not.
+			 */
 			static const SettingsProvider::Setting<bool> SHOW_OFFLINE;
+			/**
+			 * The #EXPANDED_ROSTER_GROUPS setting specifies the list of groups that are expanded
+			 * in the roster UI.
+			 *
+			 * Its value is a string with group names seperated by newlines.
+			 */
 			static const SettingsProvider::Setting<std::string> EXPANDED_ROSTER_GROUPS;
 			static const SettingsProvider::Setting<bool> PLAY_SOUNDS;
+			/**
+			 * The #HIGHLIGHT_RULES setting specifies the highlight rules and the associated actions.
+			 *
+			 * Its value is a Boost serialized representation.
+			 */
 			static const SettingsProvider::Setting<std::string> HIGHLIGHT_RULES;
 			static const SettingsProvider::Setting<bool> SPELL_CHECKER;
 			static const SettingsProvider::Setting<std::string> DICT_PATH;
 			static const SettingsProvider::Setting<std::string> PERSONAL_DICT_PATH;
 			static const SettingsProvider::Setting<std::string> DICT_FILE;
+			/**
+			 * The #INVITE_AUTO_ACCEPT_MODE setting specifies how to handle invites to chat rooms.
+			 * 
+			 * Supported values are:
+			 * - "no" : It is up to the user whether to accept the invitation and enter a room or not.
+			 * - "presence" : The invitation is automatically accepted if it is from a contact that is 
+			 *   already allowed to see the user's presence status.
+			 * - "domain" : The invitation is automatically accepted if it is from a contact that is 
+			 *   already allowed to see the user's presence status or from a contact of user's domain.
+			 */
 			static const SettingsProvider::Setting<std::string> INVITE_AUTO_ACCEPT_MODE;
+			/**
+			 * The #TRELLIS_GRID_SIZE setting specifies the dimensions of the grid used for the trellis
+			 * layout.
+			 *
+			 * Its value is a Qt serialized representation.
+			 */
 			static const SettingsProvider::Setting<std::string> TRELLIS_GRID_SIZE;
+			/**
+			 * The #TRELLIS_GRID_POSITIONS setting specifies where conversations to contacts or rooms go 
+			 * in the trellis grid.
+			 *
+			 * Its value is a Qt serialized representation.
+			 */
 			static const SettingsProvider::Setting<std::string> TRELLIS_GRID_POSITIONS;
 	};
 }
-- 
cgit v0.10.2-6-g49f6