summaryrefslogtreecommitdiffstats
path: root/src/measurementprofile/doc/src/qtmeasurementprofile.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/measurementprofile/doc/src/qtmeasurementprofile.qdoc')
-rw-r--r--src/measurementprofile/doc/src/qtmeasurementprofile.qdoc66
1 files changed, 66 insertions, 0 deletions
diff --git a/src/measurementprofile/doc/src/qtmeasurementprofile.qdoc b/src/measurementprofile/doc/src/qtmeasurementprofile.qdoc
new file mode 100644
index 00000000..b17b2f28
--- /dev/null
+++ b/src/measurementprofile/doc/src/qtmeasurementprofile.qdoc
@@ -0,0 +1,66 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** 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. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+/*!
+ \page qtmeasurementprofile-index.html
+ \title Qt Measurement Profile
+ \brief Implements the DuSE profile for measuring architecture complexity.
+
+ Qt Measurement Profile is an add-on module which implements a profile for measuring architecture complexity.
+
+ \section1 Getting Started
+ To enable Qt Measurement Profile in a project, add this directive into the C++ files:
+ \code
+ #include <QtMeasurementProfile>
+ \endcode
+ To link against the Qt Measurement Profile module, add this line to the project file:
+ \code
+ QT += measurementprofile
+ \endcode
+
+ \section1 Reference
+ These are links to the API reference materials.
+ \list
+ \li \l{Qt Measurement Profile C++ Classes}{C++ classes}
+ \endlist
+*/
+
+/*!
+ \module QtMeasurementProfile
+ \title Qt Measurement Profile C++ Classes
+ \ingroup modules
+ \brief Implements the DuSE profile for measuring architecture complexity.
+
+ To include the definitions of the module's classes, use the
+ following directive:
+
+ \snippet code/doc_src_qtmeasurementprofile.cpp 0
+
+ To link against the module, add this line to your \l qmake \c
+ .pro file:
+
+ \snippet code/doc_src_qtmeasurementprofile.pro 0
+*/