diff options
Diffstat (limited to 'src/processmanager/doc/src/namespace.qdoc')
-rw-r--r-- | src/processmanager/doc/src/namespace.qdoc | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/src/processmanager/doc/src/namespace.qdoc b/src/processmanager/doc/src/namespace.qdoc new file mode 100644 index 0000000..080faf8 --- /dev/null +++ b/src/processmanager/doc/src/namespace.qdoc @@ -0,0 +1,80 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the documentation of ProcessManager +** +** $QT_BEGIN_LICENSE:FDL$ +** GNU Free Documentation License +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms +** and conditions contained in a signed written agreement between you +** and Nokia. +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \headerfile <processmanager-global.h> + \title Global QtProcessManager declarations + + \brief The <qprocessmanager-global.h> file provides namespace declarations and + global enumerations for QtProcessManager + */ + +/*! + \macro QT_USE_NAMESPACE_PROCESSMANAGER + \relates <qprocessmanager-global.h> + \inmodule QtProcessManager + + This macro expands to using processmanager namespace and makes processmanager namespace + visible to C++ source code. + + \code + #include <qprocessmanager-global.h> + QT_USE_NAMESPACE_PROCESSMANAGER + \endcode + + To declare the class without including the declaration of the class: + + \code + #include <qprocessmanager-global.h> + QT_BEGIN_NAMESPACE_PROCESSMANAGER + class QProcessManager; + QT_END_NAMESPACE_PROCESSMANAGER + QT_USE_NAMESPACE_PROCESSMANAGER + \endcode +*/ + +/*! + \macro QT_BEGIN_NAMESPACE_PROCESSMANAGER + \relates <qprocessmanager-global.h> + \inmodule QtProcessManager + + This macro begins a QtProcessManager namespace. All forward declarations of QtProcessManager classes need to + be wrapped in \c QT_BEGIN_NAMESPACE_PROCESSMANAGER and \c QT_END_NAMESPACE_PROCESSMANAGER. + + \sa QT_USE_NAMESPACE_PROCESSMANAGER, QT_END_NAMESPACE_PROCESSMANAGER +*/ + +/*! + \macro QT_END_NAMESPACE_PROCESSMANAGER + \relates <processmanager-global.h> + \inmodule ProcessManager + + This macro ends a QProcessManager namespace. All forward declarations of QtProcessManager classes need to + be wrapped in \c QT_BEGIN_NAMESPACE_PROCESSMANAGER and \c QT_END_NAMESPACE_PROCESSMANAGER. + + \sa QT_USE_NAMESPACE_PROCESSMANAGER, QT_BEGIN_NAMESPACE_PROCESSMANAGER +*/ |