Clearify documentation on config groupsaver and give a small code example

1 files changed, 9 insertions, 0 deletions

diff --git a/libopie2/opiecore/oconfig.h b/libopie2/opiecore/oconfig.h
index 8c3060c..ab95dc3 100644
--- a/libopie2/opiecore/oconfig.h
+++ b/libopie2/opiecore/oconfig.h
@@ -1,20 +1,21 @@
 /*
                              This file is part of the Opie Project
 
                              (C) 2003 Michael 'Mickey' Lauer <mickey@tm.informatik.uni-frankfurt.de>
+
                              Inspired by the config classes from the KDE Project which are
               =.             (C) 1997 Matthias Kalle Dalheimer <kalle@kde.org>
             .=l.
            .>+-=
  _;:,     .>    :=|.         This program is free software; you can
 .> <`_,   >  .   <=          redistribute it and/or  modify it under
 :`=1 )Y*s>-.--   :           the terms of the GNU Library General Public
 .="- .-=="i,     .._         License as published by the Free Software
  - .   .-<_>     .<>         Foundation; either version 2 of the License,
      ._= =}       :          or (at your option) any later version.
     .%`+i>       _;_.
     .i_,=:_.      -<s.       This program is distributed in the hope that
      +  .  -:.       =       it will be useful,  but WITHOUT ANY WARRANTY;
     : ..    .:,     . . .    without even the implied warranty of
     =_        +     =;=|`    MERCHANTABILITY or FITNESS FOR A
   _.=:.       :    :=>`:     PARTICULAR PURPOSE. See the GNU
@@ -95,32 +96,40 @@ private:
  * config()->setGroup( "TheGroupThatIWant" );
  * ...
  * config()->writeEntry( "Blah", "Blubb" );
  *
  * config()->setGroup( oldgroup );
  * </pre>
  *
  * In order to facilitate this task, you can use
  * OConfigGroupSaver. Simply construct such an object ON THE STACK
  * when you want to switch to a new group. Then, when the object goes
  * out of scope, the group will automatically be restored. If you
  * want to use several different groups within a function or method,
  * you can still use OConfigGroupSaver: Simply enclose all work with
  * one group (including the creation of the OConfigGroupSaver object)
  * in one block.
  *
+ * \code
+ * OConfigGroupSaver saver(cfg,"TheGroupThatInWhat");
+ * \endcode
+ *
+ * Note that OConfigGroupSaver (cfg,"TheGroupThatInWhat"); would get imediately
+ * destructed after created and that you would save in the old group which
+ * is unwished.
+ *
  * @author Matthias Kalle Dalheimer <Kalle@kde.org>
  * @version $Id$
  * @see OConfig
  */
 
 class OConfigGroupSaver
 {
   public:
     /**
      * Constructor.
      * Create the object giving a @config object and a @a group to become
      * the current group.
      */
     OConfigGroupSaver( OConfig* config, QString group ) :_config(config), _oldgroup(config->group() )
         { _config->setGroup( group ); }