summaryrefslogtreecommitdiffstats
path: root/src/corelib/kernel
diff options
context:
space:
mode:
authorDavid Boddie <dboddie@trolltech.com>2009-09-04 18:46:10 (GMT)
committerDavid Boddie <dboddie@trolltech.com>2009-09-04 18:47:34 (GMT)
commitfd529383c4491580db344fb3d8035bd0ad3cb5e0 (patch)
treec215155942977ab545a08584bfff80bb002cadd5 /src/corelib/kernel
parenta9eff6cd9719572ee7bb2a50217b5cbbb9fa80c2 (diff)
downloadQt-fd529383c4491580db344fb3d8035bd0ad3cb5e0.zip
Qt-fd529383c4491580db344fb3d8035bd0ad3cb5e0.tar.gz
Qt-fd529383c4491580db344fb3d8035bd0ad3cb5e0.tar.bz2
Doc: Added info on Q_FLAGS() by providing an example with more context.
Reviewed-by: Trust Me As-seen-on: qt-interest
Diffstat (limited to 'src/corelib/kernel')
-rw-r--r--src/corelib/kernel/qobject.cpp14
1 files changed, 11 insertions, 3 deletions
diff --git a/src/corelib/kernel/qobject.cpp b/src/corelib/kernel/qobject.cpp
index c0c97b8..e93c6ee 100644
--- a/src/corelib/kernel/qobject.cpp
+++ b/src/corelib/kernel/qobject.cpp
@@ -3965,11 +3965,19 @@ QDebug operator<<(QDebug dbg, const QObject *o) {
\relates QObject
This macro registers one or several \l{QFlags}{flags types} to the
- meta-object system.
+ meta-object system. It is typically used in a class definition to declare
+ that values of a given enum can be used as flags and combined using the
+ bitwise OR operator.
- Example:
+ For example, in QLibrary, the \l{QLibrary::LoadHints}{LoadHints} flag is
+ declared in the following way:
+
+ \snippet doc/src/snippets/code/src_corelib_kernel_qobject.cpp 39a
+
+ The declaration of the flags themselves is performed in the public section
+ of the QLibrary class itself, using the \l Q_DECLARE_FLAGS() macro:
- \snippet doc/src/snippets/code/src_corelib_kernel_qobject.cpp 39
+ \snippet doc/src/snippets/code/src_corelib_kernel_qobject.cpp 39b
\note This macro takes care of registering individual flag values
with the meta-object system, so it is unnecessary to use Q_ENUMS()