diff options
| author | Jerome Pasion <jerome.pasion@digia.com> | 2012-09-25 16:24:31 +0200 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2012-09-29 12:27:10 +0200 |
| commit | 3f4a920f87842e1bbb20f72ce04d6da7a866ab1d (patch) | |
| tree | 9460b0a381c35e9137a60ec79c3070e51cd84334 /src/bluetooth/doc | |
| parent | d8a179128c0fa8e9cc482df58b9334c696602be6 (diff) | |
Qt Bluetooth: Created \qmlmodule and \module pages
These pages will list the C++ classes and the QML types in Qt Bluetooth.
Removed extra groups.
Change-Id: I27d7004d804cc0cc29af997f3a11fcc9f9477efb
Reviewed-by: Alex <ablasche@gmail.com>
Diffstat (limited to 'src/bluetooth/doc')
| -rw-r--r-- | src/bluetooth/doc/src/bluetooth-cpp.qdoc | 20 | ||||
| -rw-r--r-- | src/bluetooth/doc/src/bluetooth-qml.qdoc | 15 |
2 files changed, 11 insertions, 24 deletions
diff --git a/src/bluetooth/doc/src/bluetooth-cpp.qdoc b/src/bluetooth/doc/src/bluetooth-cpp.qdoc index 4dcb6021..425b905d 100644 --- a/src/bluetooth/doc/src/bluetooth-cpp.qdoc +++ b/src/bluetooth/doc/src/bluetooth-cpp.qdoc @@ -24,28 +24,22 @@ ** $QT_END_LICENSE$ ** ****************************************************************************/ - - - /*! -\page bluetooth-cpp.html +\module QtBluetooth \title Qt Bluetooth C++ API \brief An API enabling basic Bluetooth operations like scanning for devices and connecting them. -\ingroup qtconnectivity -\ingroup qtconnectivity-c++ - -The Qt Bluetooth C++ API enables an application to scan for devices and connect and -interact with them in a more flexible way than the \l{Qt Bluetooth QML API}. -\section1 Classes + The \l{Qt Bluetooth} C++ API enables an application to scan for devices and + connect and interact with them in a more flexible way than the \l{Qt + Bluetooth QML API}. -\list -\annotatedlist connectivity-bluetooth -\endlist + To use the C++ library in your application, add the following configuration + option to your \c .pro file: + \snippet doc_src_qtbluetooth.pro contacts project modification */ diff --git a/src/bluetooth/doc/src/bluetooth-qml.qdoc b/src/bluetooth/doc/src/bluetooth-qml.qdoc index 36c4d4fd..84a7da5f 100644 --- a/src/bluetooth/doc/src/bluetooth-qml.qdoc +++ b/src/bluetooth/doc/src/bluetooth-qml.qdoc @@ -28,27 +28,20 @@ /*! -\page bluetooth-qml.html - +\qmlmodule QtBluetooth 5.0 \title Qt Bluetooth QML API \brief A QML API enabling basic Bluetooth operations like scanning for devices and connecting them. -\ingroup qtconnectivity -\ingroup qtconnectivity-qml - The Qt Bluetooth QML API enables an application to scan for devices and connect and interact with them in an easier way than the C++ Classes. However, it is a bit more limited than the C++ API. You can always use the C++ API to create QML plugins with the flexibility you need. -\tableofcontents - -\section1 QML Types +To use the classes of the module in your application you need the following +import statement in your \c .qml file: -\list -\annotatedlist bluetooth-qml -\endlist +\snippet doc_src_qtbluetooth.qml import */ |