diff options
author | Aaron McCarthy <mccarthy.aaron@gmail.com> | 2012-10-08 22:43:52 +1000 |
---|---|---|
committer | Aaron McCarthy <mccarthy.aaron@gmail.com> | 2013-01-30 12:23:50 +0100 |
commit | a9609faf443103756a06bce434ad600e7104c1aa (patch) | |
tree | affff43425379927bf5eb9357e6ac8d4aefa3624 /src/bluetooth/doc | |
parent | 318e889fd4c61336d658f419fb686bde3c3d06e3 (diff) |
Modularise documentation.
Qt Bluetooth documentation had been modularised but it was still
building using the old version. Use the qtbluetooth.qdocconf instead.
Modularise the Qt NFC Documentation.
Change-Id: Idea1631645bf21750254eddc1c41a4f819ac5156
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/bluetooth/doc')
-rw-r--r-- | src/bluetooth/doc/qtbluetooth.qdocconf | 25 | ||||
-rw-r--r-- | src/bluetooth/doc/src/bluetooth-cpp.qdoc | 2 | ||||
-rw-r--r-- | src/bluetooth/doc/src/bluetooth-index.qdoc | 119 |
3 files changed, 68 insertions, 78 deletions
diff --git a/src/bluetooth/doc/qtbluetooth.qdocconf b/src/bluetooth/doc/qtbluetooth.qdocconf index 3ee3ffcc..99bf575b 100644 --- a/src/bluetooth/doc/qtbluetooth.qdocconf +++ b/src/bluetooth/doc/qtbluetooth.qdocconf @@ -1,37 +1,42 @@ -include(../../../doc/global/qt-html-templates-offline.qdocconf) -include(../../../doc/global/qt-module-defaults.qdocconf) +include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) project = QtBluetooth description = Qt Bluetooth Reference Documentation -url = http://qt-project.org/doc/qt-5.0/qtbluetooth-index.html version = 5.0.0 +examplesinstallpath = bluetooth + qhp.projects = QtBluetooth qhp.QtBluetooth.file = qtbluetooth.qhp qhp.QtBluetooth.namespace = org.qt-project.qtbluetooth.500 -qhp.QtBluetooth.virtualFolder = qdoc -qhp.QtBluetooth.indexTitle = Qt Bluetooth Reference Documentation +qhp.QtBluetooth.virtualFolder = qtbluetooth +qhp.QtBluetooth.indexTitle = Qt Bluetooth qhp.QtBluetooth.indexRoot = qhp.QtBluetooth.filterAttributes = qtbluetooth 5.0.0 qtrefdoc qhp.QtBluetooth.customFilters.Qt.name = QtBluetooth 5.0.0 qhp.QtBluetooth.customFilters.Qt.filterAttributes = qtbluetooth 5.0.0 -qhp.QtBluetooth.subprojects = classes overviews examples -qhp.QtBluetooth.subprojects.classes.title = Classes -qhp.QtBluetooth.subprojects.classes.indexTitle = Qt Bluetooth's Classes +qhp.QtBluetooth.subprojects = overviews classes qml examples +qhp.QtBluetooth.subprojects.classes.title = C++ Classes +qhp.QtBluetooth.subprojects.classes.indexTitle = Qt Bluetooth C++ Classes qhp.QtBluetooth.subprojects.classes.selectors = class fake:headerfile qhp.QtBluetooth.subprojects.classes.sortPages = true +qhp.QtBluetooth.subprojects.qml.title = QML Types +qhp.QtBluetooth.subprojects.qml.indexTitle = Qt Bluetooth QML Types +qhp.QtBluetooth.subprojects.qml.selectors = fake:headerfile +qhp.QtBluetooth.subprojects.qml.sortPages = true qhp.QtBluetooth.subprojects.overviews.title = Overviews -qhp.QtBluetooth.subprojects.overviews.indexTitle = All Overviews and HOWTOs +qhp.QtBluetooth.subprojects.overviews.indexTitle = Qt Bluetooth Overview qhp.QtBluetooth.subprojects.overviews.selectors = fake:page,group,module qhp.QtBluetooth.subprojects.examples.title = Qt Bluetooth Examples qhp.QtBluetooth.subprojects.examples.indexTitle = Qt Bluetooth Examples qhp.QtBluetooth.subprojects.examples.selectors = fake:example -outputdir = ../../../doc/qtbluetooth tagfile = ../../../doc/qtbluetooth/qtbluetooth.tags +depends += qtcore + headerdirs += .. \ ../../imports/bluetooth diff --git a/src/bluetooth/doc/src/bluetooth-cpp.qdoc b/src/bluetooth/doc/src/bluetooth-cpp.qdoc index 425b905d..26bbc3e9 100644 --- a/src/bluetooth/doc/src/bluetooth-cpp.qdoc +++ b/src/bluetooth/doc/src/bluetooth-cpp.qdoc @@ -28,7 +28,7 @@ \module QtBluetooth -\title Qt Bluetooth C++ API +\title Qt Bluetooth C++ Classes \brief An API enabling basic Bluetooth operations like scanning for devices and connecting them. diff --git a/src/bluetooth/doc/src/bluetooth-index.qdoc b/src/bluetooth/doc/src/bluetooth-index.qdoc index 371de05c..ff1651d0 100644 --- a/src/bluetooth/doc/src/bluetooth-index.qdoc +++ b/src/bluetooth/doc/src/bluetooth-index.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2013 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. @@ -26,70 +26,55 @@ ****************************************************************************/ /*! - \page qtbluetooth-index.html - \title Qt Bluetooth - \brief Qt Bluetooth enables connectivity between Bluetooth enabled devices. - - Bluetooth is a short-range (less than 100 meters) wireless technology. It - has a reasonably high data transfer rate of 2.1 Mbit/s, which makes it ideal - for transfering data between devices. - - Bluetooth connectivity is based on basic device management, such as scanning - for devices, gathering information about them, and exchaning data between - them. - - \section1 Getting Started - - 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 - - To use the classes of the module in your application you need the following - import statement in your \c .qml file: - - \snippet doc_src_qtbluetooth.qml import - - \section1 References - - \table - \header - \li {1,4} Reference - \li {1,4} Guides - \li {4,1} Examples - \header - \li QML API examples - \li C++ API examples - \row - \li \l{Qt Bluetooth QML API} - \li \l{Qt Bluetooth Overview} - \li \l{btscanner}{QML Bluetooth Scanner} - - A QML implementation of the Bluetooth device scanner. - \li \l{btscanner}{Bluetooth Scanner} - - Scan for Bluetooth devices. - \row - \li \l{Qt Bluetooth C++ API} - \li \l{btchat}{Qt Bluetooth Tutorial} - - A chat server and client using bluetooth. - \li \l{bttennis}{QML Bluetooth Tennis} - - The tennis game using a QML interface to the Qt Bluetooth QML API. - It must connect to an instance of the C++ tennis game to play. - \li \l{bttennis}{Bluetooth Tennis} - - The classic game of \l{http://en.wikipedia.org/wiki/Pong}{Pong}. - Supports multiplayer over Bluetooth and touch-to-play - functionality on devices that support NFC. - \row - \li - \li - \li - \li \l{btfiletransfer}{Bluetooth File Transfer} - - Transfer files between Bluetooth devices. - \endtable - +\page qtbluetooth-index.html +\title Qt Bluetooth +\brief Qt Bluetooth enables connectivity between Bluetooth enabled devices. + +Bluetooth is a short-range (less than 100 meters) wireless technology. It +has a reasonably high data transfer rate of 2.1 Mbit/s, which makes it ideal +for transferring data between devices. + +Bluetooth connectivity is based on basic device management, such as scanning +for devices, gathering information about them, and exchaning data between +them. + +\section1 Getting started + +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 + +To use the classes of the module in your application you need the following +import statement in your \c .qml file: + +\snippet doc_src_qtbluetooth.qml import + +\section1 Related information + +\section2 Guides +\list + \li \l {Qt Bluetooth Overview} +\endlist + +\section2 Reference +\list + \li \l {Qt Bluetooth QML Types}{QML Types} + \li \l {Qt Bluetooth C++ Classes}{C++ Classes} +\endlist + +\section2 Examples +\list + \li QML + \list + \li \l {scanner}{QML Bluetooth Scanner} + \endlist + \li C++ + \list + \li \l {btchat}{Bluetooth Chat} + \li \l {btscanner}{Bluetooth Scanner} + \li \l {bttennis}{Bluetooth Tennis} + \li \l {btfiletransfer}{Bluetooth File Transfer} + \endlist +\endlist */ |