| author | zecke <zecke> | 2004-05-17 21:19:23 (UTC) |
|---|---|---|
| committer | zecke <zecke> | 2004-05-17 21:19:23 (UTC) |
| commit | 34f42c17874e84239fc2bff241cecee7ec78d38d (patch) (side-by-side diff) | |
| tree | 20f4a9fd49330e46599e1c2a0671a518692ec943 | |
| parent | 598c9bc76840120fa3efdb000461bae2c1fef639 (diff) | |
| download | opie-34f42c17874e84239fc2bff241cecee7ec78d38d.zip opie-34f42c17874e84239fc2bff241cecee7ec78d38d.tar.gz opie-34f42c17874e84239fc2bff241cecee7ec78d38d.tar.bz2 | |
Clearify documentation on config groupsaver and give a small code example
| -rw-r--r-- | libopie2/opiecore/oconfig.h | 9 |
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,10 +1,11 @@ /* 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 @@ -105,12 +106,20 @@ private: * 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 |