From 0e90ba078db079020fefc022eb393ebe857804a2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jan=20M=C3=B6bius?= <moebius@cs.rwth-aachen.de>
Date: Thu, 3 Dec 2009 15:48:40 +0000
Subject: [PATCH] Documentation for globaloptions

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@7736 383ad7c9-94d9-4d36-a494-682f7c89f535
---
 common/GlobalOptions.hh | 29 +++++++++++++++--------------
 1 file changed, 15 insertions(+), 14 deletions(-)

diff --git a/common/GlobalOptions.hh b/common/GlobalOptions.hh
index 77385cd3..6007a2ea 100644
--- a/common/GlobalOptions.hh
+++ b/common/GlobalOptions.hh
@@ -72,26 +72,27 @@
 
 /** \brief QSettings object containing all program settings of OpenFlipper.
 *
-* To get the settings use: 
-* OpenFlipperSettings().value("<Key>").toDouble();
+* To get the settings use:\n
+* OpenFlipperSettings().value("<Key>").toDouble();\n
 * OpenFlipperSettings().value("<Key>").toBool();
 *
-* To change settings do:
-* OpenFlipperSettings().setValue("<Key>",<Value>);
-* For detailed info about the values see the documentation of QSettings and the QVariant.
+* To change settings do:\n
+* OpenFlipperSettings().setValue("<Key>","<Value>");\n
+* For detailed info about the values see the documentation of QSettings and the QVariant.\n
 *
-* The following entries are available through the settings:
+* <b>For each of your plugins, the key has to start with your plugin name!!!</b>
 *
-* General Stereo Settings:\n
-* * Core/Stereo/EyeDistance   \t  Distance between eyes. Defaults to 7 cm (double)\n
-* * Core/Stereo/FocalDistance \t  Focal distance. Defaults to center of scene (double)\n
+* The following entries are available through the settings:
 *
+* <b>General Stereo Settings<b>\n
+* * Core/Stereo/EyeDistance    Distance between eyes. Defaults to 7 cm (double)\n
+* * Core/Stereo/FocalDistance  Focal distance. Defaults to center of scene (double)\n
 * \n
-* Philips stereo display settings:\n
-* * Core/Stereo/Philips/Content \t Philips stereo header content type (int)
-* * Core/Stereo/Philips/Factor  \t Philips stereo header factor (int)
-* * Core/Stereo/Philips/Offset  \t Philips stereo header offset cc (int)
-* * Core/Stereo/Philips/Select  \t Philips stereo header select (int)
+* <b>Philips stereo display settings<b>\n
+* * Core/Stereo/Philips/Content  Philips stereo header content type (int)\n
+* * Core/Stereo/Philips/Factor   Philips stereo header factor (int)\n
+* * Core/Stereo/Philips/Offset   Philips stereo header offset cc (int)\n
+* * Core/Stereo/Philips/Select   Philips stereo header select (int)\n
 * \n
 * Anaglyph stereo mode settings:\n
 */
-- 
GitLab