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 | |
| 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>
29 files changed, 576 insertions, 528 deletions
diff --git a/doc/compat.qdocconf b/doc/compat.qdocconf deleted file mode 100644 index 53a26136..00000000 --- a/doc/compat.qdocconf +++ /dev/null @@ -1,31 +0,0 @@ -alias.i = e -alias.include = input - -macro.0 = "\\\\0" -macro.b = "\\\\b" -macro.n = "\\\\n" -macro.r = "\\\\r" -macro.i = "\\li" -macro.i11 = "\\li{1,1}" -macro.i12 = "\\li{1,2}" -macro.i13 = "\\li{1,3}" -macro.i14 = "\\li{1,4}" -macro.i15 = "\\li{1,5}" -macro.i16 = "\\li{1,6}" -macro.i17 = "\\li{1,7}" -macro.i18 = "\\li{1,8}" -macro.i19 = "\\li{1,9}" -macro.i21 = "\\li{2,1}" -macro.i31 = "\\li{3,1}" -macro.i41 = "\\li{4,1}" -macro.i51 = "\\li{5,1}" -macro.i61 = "\\li{6,1}" -macro.i71 = "\\li{7,1}" -macro.i81 = "\\li{8,1}" -macro.i91 = "\\li{9,1}" -macro.img = "\\image" -macro.endquote = "\\endquotation" -macro.relatesto = "\\relates" - -spurious = "Missing comma in .*" \ - "Missing pattern .*" diff --git a/doc/macros.qdocconf b/doc/macros.qdocconf deleted file mode 100644 index dd468412..00000000 --- a/doc/macros.qdocconf +++ /dev/null @@ -1,43 +0,0 @@ -macro.aacute.HTML = "á" -macro.Aring.HTML = "Å" -macro.aring.HTML = "å" -macro.Auml.HTML = "Ä" -macro.author = "\\b{Author:}" -macro.br.HTML = "<br />" -macro.BR.HTML = "<br />" -macro.copyright.HTML = "©" -macro.eacute.HTML = "é" -macro.gui = "\\b" -macro.hr.HTML = "<hr />" -macro.iacute.HTML = "í" -macro.key = "\\b" -macro.menu = "\\b" -macro.note = "\\b{Note:}" -macro.oslash.HTML = "ø" -macro.ouml.HTML = "ö" -macro.QA = "Qt Assistant" -macro.QC = "Creator" -macro.QD = "Qt Designer" -macro.QL = "Qt Linguist" -macro.QMLD = "Qt Quick Designer" -macro.QQV = "Qt QML Viewer" -macro.QSDK = "Qt SDK" -#macro.qtcversion = $QTC_VERSION -macro.qtcversion = "0.0" -macro.param = "\\e" -macro.raisedaster.HTML = "<sup>*</sup>" -macro.rarrow.HTML = "→" -macro.reg.HTML = "<sup>®</sup>" -macro.return = "Returns" -macro.starslash = "\\c{*/}" -macro.begincomment = "\\c{/*}" -macro.endcomment = "\\c{*/}" -macro.uuml.HTML = "ü" -macro.mdash.HTML = "—" -macro.pi.HTML = "Π" - -macro.beginfloatleft.HTML = "<div style=\"float: left; margin-right: 2em\">" -macro.beginfloatright.HTML = "<div style=\"float: right; margin-left: 2em\">" -macro.endfloat.HTML = "</div>" -macro.clearfloat.HTML = "<br style=\"clear: both\" />" -macro.emptyspan.HTML = "<span></span>" diff --git a/doc/qt-cpp-ignore.qdocconf b/doc/qt-cpp-ignore.qdocconf deleted file mode 100644 index edc7c7c1..00000000 --- a/doc/qt-cpp-ignore.qdocconf +++ /dev/null @@ -1,106 +0,0 @@ -Cpp.ignoretokens = QAXFACTORY_EXPORT \ - QDESIGNER_COMPONENTS_LIBRARY \ - QDESIGNER_EXTENSION_LIBRARY \ - QDESIGNER_SDK_LIBRARY \ - QDESIGNER_SHARED_LIBRARY \ - QDESIGNER_UILIB_LIBRARY \ - QM_EXPORT_CANVAS \ - QM_EXPORT_DNS \ - QM_EXPORT_DOM \ - QM_EXPORT_FTP \ - QM_EXPORT_HTTP \ - QM_EXPORT_ICONVIEW \ - QM_EXPORT_NETWORK \ - QM_EXPORT_OPENGL \ - QM_EXPORT_OPENVG \ - QM_EXPORT_SQL \ - QM_EXPORT_TABLE \ - QM_EXPORT_WORKSPACE \ - QM_EXPORT_XML \ - QT_ASCII_CAST_WARN \ - QT_ASCII_CAST_WARN_CONSTRUCTOR \ - QT_BEGIN_HEADER \ - QT_DESIGNER_STATIC \ - QT_END_HEADER \ - QT_FASTCALL \ - QT_WIDGET_PLUGIN_EXPORT \ - Q_COMPAT_EXPORT \ - Q_CORE_EXPORT \ - Q_CORE_EXPORT_INLINE \ - Q_EXPLICIT \ - Q_EXPORT \ - Q_EXPORT_CODECS_CN \ - Q_EXPORT_CODECS_JP \ - Q_EXPORT_CODECS_KR \ - Q_EXPORT_PLUGIN \ - Q_GFX_INLINE \ - Q_AUTOTEST_EXPORT \ - Q_GUI_EXPORT \ - Q_GUI_EXPORT_INLINE \ - Q_GUI_EXPORT_STYLE_CDE \ - Q_GUI_EXPORT_STYLE_COMPACT \ - Q_GUI_EXPORT_STYLE_MAC \ - Q_GUI_EXPORT_STYLE_MOTIF \ - Q_GUI_EXPORT_STYLE_MOTIFPLUS \ - Q_GUI_EXPORT_STYLE_PLATINUM \ - Q_GUI_EXPORT_STYLE_POCKETPC \ - Q_GUI_EXPORT_STYLE_SGI \ - Q_GUI_EXPORT_STYLE_WINDOWS \ - Q_GUI_EXPORT_STYLE_WINDOWSXP \ - QHELP_EXPORT \ - Q_INLINE_TEMPLATE \ - Q_INTERNAL_WIN_NO_THROW \ - Q_LOCATION_EXPORT \ - Q_NETWORK_EXPORT \ - Q_OPENGL_EXPORT \ - Q_OPENVG_EXPORT \ - Q_OUTOFLINE_TEMPLATE \ - Q_SQL_EXPORT \ - Q_SVG_EXPORT \ - Q_SCRIPT_EXPORT \ - Q_SCRIPTTOOLS_EXPORT \ - Q_TESTLIB_EXPORT \ - Q_TYPENAME \ - Q_XML_EXPORT \ - Q_XMLSTREAM_EXPORT \ - Q_XMLPATTERNS_EXPORT \ - QDBUS_EXPORT \ - Q_DBUS_EXPORT \ - QT_BEGIN_NAMESPACE \ - QT_BEGIN_INCLUDE_NAMESPACE \ - QT_END_NAMESPACE \ - QT_END_INCLUDE_NAMESPACE \ - QTNFC_BEGIN_NAMESPACE \ - QTNFC_END_NAMESPACE \ - Q_NFC_EXPORT \ - QTBLUETOOTH_BEGIN_NAMESPACE \ - QTBLUETOOTH_END_NAMESPACE \ - Q_BLUETOOTH_EXPORT \ - PHONON_EXPORT \ - Q_DECLARATIVE_EXPORT \ - Q_GADGET \ - QWEBKIT_EXPORT \ - Q_INVOKABLE \ - Q_DECL_CONSTEXPR -Cpp.ignoredirectives = Q_DECLARE_HANDLE \ - Q_DECLARE_INTERFACE \ - Q_DECLARE_METATYPE \ - Q_DECLARE_OPERATORS_FOR_FLAGS \ - Q_DECLARE_PRIVATE \ - Q_DECLARE_PUBLIC \ - Q_DECLARE_SHARED \ - Q_DECLARE_TR_FUNCTIONS \ - Q_DECLARE_TYPEINFO \ - Q_DISABLE_COPY \ - QT_FORWARD_DECLARE_CLASS \ - Q_DUMMY_COMPARISON_OPERATOR \ - Q_ENUMS \ - Q_FLAGS \ - Q_INTERFACES \ - __attribute__ \ - K_DECLARE_PRIVATE \ - PHONON_OBJECT \ - PHONON_HEIR \ - Q_PRIVATE_PROPERTY \ - Q_DECLARE_PRIVATE_D \ - Q_CLASSINFO diff --git a/doc/qt-defines.qdocconf b/doc/qt-defines.qdocconf deleted file mode 100644 index aaf935ac..00000000 --- a/doc/qt-defines.qdocconf +++ /dev/null @@ -1,18 +0,0 @@ -defines = Q_QDOC \ - QT_.*_SUPPORT \ - QT_.*_LIB \ - QT_COMPAT \ - QT_KEYPAD_NAVIGATION \ - QT_NO_EGL \ - QT3_SUPPORT \ - Q_WS_.* \ - Q_OS_.* \ - Q_BYTE_ORDER \ - QT_DEPRECATED \ - Q_NO_USING_KEYWORD \ - __cplusplus \ - Q_COMPILER_INITIALIZER_LISTS - -versionsym = QT_VERSION_STR - -codeindent = 1 diff --git a/doc/qt5-dita.qdocconf b/doc/qt5-dita.qdocconf deleted file mode 100644 index 39bd1007..00000000 --- a/doc/qt5-dita.qdocconf +++ /dev/null @@ -1,27 +0,0 @@ -# Name of the project. -project = qtconnectivity - -# Directories in which to search for files to document and images. -# By default set to the root directory of the project for sources -# and headers and qdoc will therefore generate output for each file. -# Images should be placed in <rootdir>/dic/images and examples in -# <rootdir>/examples. -# Paths are relative to the location of this file. -exampledirs += ../examples -headerdirs += ../src/bluetooth ../src/imports/bluetooth -imagedirs += src/images -sourcedirs += ../src/bluetooth \ - ../src/imports/bluetooth \ - src -excludedirs += ../tests - - - - -#Do not change the variables after this line unless you know what you are doing. - -outputdir = ditaxml -outputformats = DITAXML - -sources.fileextensions = "*.cpp *.qdoc *.mm *.qml" -headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx" diff --git a/doc/qtconnectivity.qdocconf b/doc/qtconnectivity.qdocconf deleted file mode 100644 index 66381b7f..00000000 --- a/doc/qtconnectivity.qdocconf +++ /dev/null @@ -1,80 +0,0 @@ -include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf) -include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) - -# Name of the project. -project = qtconnectivity - -include(qt-cpp-ignore.qdocconf) -include(qt-defines.qdocconf) -include(compat.qdocconf) -include(macros.qdocconf) - -# Directories in which to search for files to document and images. -# By default set to the root directory of the project for sources -# and headers and qdoc will therefore generate output for each file. -# Images should be placed in <rootdir>/dic/images and examples in -# <rootdir>/examples. -# Paths are relative to the location of this file. -exampledirs += ../examples -headerdirs += ../src/bluetooth ../src/imports/bluetooth -imagedirs += src/images -sourcedirs += ../src/bluetooth \ - ../src/imports/bluetooth \ - src -excludedirs += ../tests - -# The following parameters are for creating a qhp file, the qhelpgenerator -# program can convert the qhp file into a qch file which can be opened in -# Qt Assistant and/or Qt Creator. - -# Defines the name of the project. You cannot use operators (+, =, -) in -# the name. Properties for this project are set using a qhp.<projectname>.property -# format. -qhp.projects = qtconnectivity - -# Sets the name of the output qhp file. -qhp.qtconnectivity.file = qtconnectivity.qhp - -# Namespace for the output file. This namespace is used to distinguish between -# different documentation files in Creator/Assistant. Normal format for MP -# projects should be: com.nokia.mp.<projectname>.version with version being -# a number containing a major, minor and revision element. E.g. version 1.0 -# becomes 100. -qhp.qtconnectivity.namespace = com.nokia.mp.qtconnectivity.100 - -# Title for the package, will be the main title for the package in -# Assistant/Creator. -qhp.qtconnectivity.indexTitle = Qt Local Connectivity Reference Documentation - -# Extra files to add to the output which are not linked to from anywhere -# using a qdoc \l command. -qhp.qtconnectivity.extraFiles = style/style.css \ - index.html - -# Only update the name of the project for the next variables. -qhp.qtconnectivity.virtualFolder = qdoc -qhp.qtconnectivity.subprojects = classes -qhp.qtconnectivity.subprojects.classes.title = Classes -qhp.qtconnectivity.subprojects.classes.selectors = class fake:headerfile -qhp.qtconnectivity.subprojects.classes.sortPages = true - - - -# Do NOT change the variables after this line unless you know what you are doing. - -outputformats = HTML - -examples.fileextensions = "*.cpp *.h *.js *.svg *.xml *.ui *.qml" -examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng" -headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx" -sources.fileextensions = "*.cpp *.qdoc *.mm *.qml" - -HTML.nobreadcrumbs = "true" - -HTML.templatedir = . -HTML.stylesheets = style/style.css - -HTML.headerstyles = " <link rel=\"stylesheet\" type=\"text/css\" href=\"style/style.css\" />\n" -HTML.endheader = "</head>\n<body>\n" - -HTML.footer = "<div class=\"footer\">Copyright (c) 2012 Nokia Corporation and/or its subsidiaries. All rights reserved.</div>\n" diff --git a/doc/style/style.css b/doc/style/style.css deleted file mode 100644 index df84049f..00000000 --- a/doc/style/style.css +++ /dev/null @@ -1,137 +0,0 @@ -a:link, a:visited { - color: #00732F; - text-decoration: none; - font-weight: bold; -} - -body { - font: normal 400 14px/1.2 Arial; - margin-top: 85px; -} - -h1 { - margin: 0; -} - -h2 { - font: 500 20px/1.2 Arial; -} - -h3.fn, span.fn { - -moz-border-radius: 7px 7px 7px 7px; - -webkit-border-radius: 7px 7px 7px 7px; - border-radius: 7px 7px 7px 7px; - background-color: #F6F6F6; - border-width: 1px; - border-style: solid; - border-color: #E6E6E6; - word-spacing: 3px; - padding: 3px 5px; -} - -table, pre { - -moz-border-radius: 7px 7px 7px 7px; - -webkit-border-radius: 7px 7px 7px 7px; - border-radius: 7px 7px 7px 7px; - background-color: #F6F6F6; - border: 1px solid #E6E6E6; - border-collapse: separate; - font-size: 12px; - line-height: 1.2; - margin-bottom: 25px; - margin-left: 15px; -} - -table td { - padding: 3px 15px 3px 20px; -} - -table tr.even { - background-color: white; - color: #66666E; -} - -table tr.odd { - background-color: #F6F6F6; - color: #66666E; -} - -li { - margin-bottom: 10px; - padding-left: 12px; -} - -.cpp { - display: block; - margin: 10; - overflow: hidden; - overflow-x: hidden; - overflow-y: hidden; - padding: 20px 0 20px 0; -} - -.footer { - margin-top: 50px; -} - -.memItemLeft { - padding-right: 3px; -} - -.memItemRight { - padding: 3px 15px 3px 0; -} - -.qml { - display: block; - margin: 10; - overflow: hidden; - overflow-x: hidden; - overflow-y: hidden; - padding: 20px 0 20px 0; -} - -.qmldefault { - padding-left: 5px; - float: right; - color: red; -} - -.qmlreadonly { - padding-left: 5px; - float: right; - color: #254117; -} - -.rightAlign { - padding: 3px 5px 3px 10px; - text-align: right; -} - -.title { - background-color: white; - color: #44A51C; - font-family: Verdana; - font-size: 35px; - font-weight: normal; - left: 0; - padding-bottom: 5px; - padding-left: 16px; - padding-top: 20px; - position: absolute; - right: 0; - top: 0; -} - -.toc { - float: right; - -moz-border-radius: 7px 7px 7px 7px; - -webkit-border-radius: 7px 7px 7px 7px; - border-radius: 7px 7px 7px 7px; - background-color: #F6F6F6; - border: 1px solid #DDD; - margin: 0 20px 10px 10px; - padding: 20px 15px 20px 20px; - height: auto; - width: 200px; -} diff --git a/examples/bluetooth/scanner/doc/src/scanner.qdoc b/examples/bluetooth/scanner/doc/src/scanner.qdoc new file mode 100644 index 00000000..5233e31f --- /dev/null +++ b/examples/bluetooth/scanner/doc/src/scanner.qdoc @@ -0,0 +1,33 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Aaron McCarthy <mccarthy.aaron@gmail.com> +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt local connectivty modules. +** +** $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$ +** +****************************************************************************/ + +/*! +\example scanner +\title QML Bluetooth Scanner Example + +An example on how to locate Bluetooth devices in QML. +*/ diff --git a/src/bluetooth/bluetooth.pro b/src/bluetooth/bluetooth.pro index 58f73e02..a741643f 100644 --- a/src/bluetooth/bluetooth.pro +++ b/src/bluetooth/bluetooth.pro @@ -2,7 +2,8 @@ TARGET = QtBluetooth QT = core QT_PRIVATE = concurrent -QMAKE_DOCS = $$PWD/../../doc/qtconnectivity.qdocconf +QMAKE_DOCS = $$PWD/doc/qtbluetooth.qdocconf +OTHER_FILES += doc/src/*.qdoc # show .qdoc files in Qt Creator load(qt_module) 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 */ diff --git a/src/imports/nfc/qdeclarativendeffilter.cpp b/src/imports/nfc/qdeclarativendeffilter.cpp index ff21d76a..fe526e07 100644 --- a/src/imports/nfc/qdeclarativendeffilter.cpp +++ b/src/imports/nfc/qdeclarativendeffilter.cpp @@ -47,7 +47,7 @@ \brief The NdefFilter type represents a filtering constraint for NDEF message records. \ingroup nfc-qml - \inmodule QtNfc + \inqmlmodule QtNfc 5.0 \sa NearField \sa QNdefFilter diff --git a/src/imports/nfc/qdeclarativendefmimerecord.cpp b/src/imports/nfc/qdeclarativendefmimerecord.cpp index d73b1526..79813375 100644 --- a/src/imports/nfc/qdeclarativendefmimerecord.cpp +++ b/src/imports/nfc/qdeclarativendefmimerecord.cpp @@ -47,7 +47,7 @@ \brief The NdefMimeRecord type represents an NFC MIME record. \ingroup connectivity-nfc - \inmodule QtNfc + \inqmlmodule QtNfc 5.0 \inherits NdefRecord diff --git a/src/imports/nfc/qdeclarativendeftextrecord.cpp b/src/imports/nfc/qdeclarativendeftextrecord.cpp index 3cc0d5fb..0fa73c0f 100644 --- a/src/imports/nfc/qdeclarativendeftextrecord.cpp +++ b/src/imports/nfc/qdeclarativendeftextrecord.cpp @@ -49,7 +49,7 @@ \brief The NdefTextRecord type represents an NFC RTD-Text NDEF record. \ingroup nfc-qml - \inmodule QtNfc + \inqmlmodule QtNfc 5.0 \inherits NdefRecord diff --git a/src/imports/nfc/qdeclarativendefurirecord.cpp b/src/imports/nfc/qdeclarativendefurirecord.cpp index f2af4b0e..b7c4f211 100644 --- a/src/imports/nfc/qdeclarativendefurirecord.cpp +++ b/src/imports/nfc/qdeclarativendefurirecord.cpp @@ -49,7 +49,7 @@ \brief The NdefUriRecord type represents an NFC RTD-URI NDEF record. \ingroup nfc-qml - \inmodule QtNfc + \inqmlmodule QtNfc 5.0 \inherits NdefRecord diff --git a/src/imports/nfc/qdeclarativenearfield.cpp b/src/imports/nfc/qdeclarativenearfield.cpp index 6c9577a4..8e42487f 100644 --- a/src/imports/nfc/qdeclarativenearfield.cpp +++ b/src/imports/nfc/qdeclarativenearfield.cpp @@ -55,7 +55,7 @@ \brief The NearField type provides access to NDEF messages stored on NFC Forum tags. \ingroup nfc-qml - \inmodule QtNfc + \inqmlmodule QtNfc 5.0 \sa NdefFilter \sa NdefRecord diff --git a/src/imports/nfc/qdeclarativenearfieldsocket.cpp b/src/imports/nfc/qdeclarativenearfieldsocket.cpp index 8dc9a65c..b7dcaf2a 100644 --- a/src/imports/nfc/qdeclarativenearfieldsocket.cpp +++ b/src/imports/nfc/qdeclarativenearfieldsocket.cpp @@ -49,7 +49,7 @@ \brief The NearFieldSocket type represents an LLCP socket. \ingroup nfc-qml - \inmodule QtNfc + \inqmlmodule QtNfc 5.0 \sa QLlcpSocket \sa QLlcpServer diff --git a/src/nfc/doc/qtnfc.qdocconf b/src/nfc/doc/qtnfc.qdocconf new file mode 100644 index 00000000..188ef92b --- /dev/null +++ b/src/nfc/doc/qtnfc.qdocconf @@ -0,0 +1,50 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) + +project = QtNfc +description = Qt NFC Reference Documentation +version = 5.0.0 + +examplesinstallpath = nfc + +qhp.projects = QtNfc + +qhp.QtNfc.file = qtnfc.qhp +qhp.QtNfc.namespace = org.qt-project.qtnfc.500 +qhp.QtNfc.virtualFolder = qtnfc +qhp.QtNfc.indexTitle = Qt NFC +qhp.QtNfc.indexRoot = + +qhp.QtNfc.filterAttributes = qtnfc 5.0.0 qtrefdoc +qhp.QtNfc.customFilters.Qt.name = QtNfc 5.0.0 +qhp.QtNfc.customFilters.Qt.filterAttributes = qtnfc 5.0.0 +qhp.QtNfc.subprojects = overviews classes qml examples +qhp.QtNfc.subprojects.classes.title = C++ Classes +qhp.QtNfc.subprojects.classes.indexTitle = Qt NFC C++ Classes +qhp.QtNfc.subprojects.classes.selectors = class fake:headerfile +qhp.QtNfc.subprojects.classes.sortPages = true +qhp.QtNfc.subprojects.qml.title = QML Types +qhp.QtNfc.subprojects.qml.indexTitle = Qt NFC QML Types +qhp.QtNfc.subprojects.qml.selectors = fake:headerfile +qhp.QtNfc.subprojects.qml.sortPages = true +qhp.QtNfc.subprojects.overviews.title = Overviews +qhp.QtNfc.subprojects.overviews.indexTitle = Qt NFC Overview +qhp.QtNfc.subprojects.overviews.selectors = fake:page,group,module +qhp.QtNfc.subprojects.examples.title = Qt NFC Examples +qhp.QtNfc.subprojects.examples.indexTitle = Qt NFC Examples +qhp.QtNfc.subprojects.examples.selectors = fake:example + +tagfile = ../../../doc/qtnfc/qtnfc.tags + +depends += qtcore + +headerdirs += .. \ + ../../imports/nfc + +sourcedirs += .. \ + ../../imports/nfc \ + +exampledirs += ../../../examples/nfc \ + snippets/ + + +imagedirs += images diff --git a/src/nfc/doc/snippets/doc_src_qtnfc.cpp b/src/nfc/doc/snippets/doc_src_qtnfc.cpp new file mode 100644 index 00000000..8597297c --- /dev/null +++ b/src/nfc/doc/snippets/doc_src_qtnfc.cpp @@ -0,0 +1,48 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Aaron McCarthy <mccarthy.aaron@gmail.com> +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:BSD$ +** You may use this file under the terms of the BSD license as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names +** of its contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +//! [include] +#include <QtNfc/QNearFieldManager> +//! [include] + +//! [namespace] +QTNFC_USE_NAMESPACE +//! [namespace] + diff --git a/src/nfc/doc/snippets/doc_src_qtnfc.pro b/src/nfc/doc/snippets/doc_src_qtnfc.pro new file mode 100644 index 00000000..03a552a6 --- /dev/null +++ b/src/nfc/doc/snippets/doc_src_qtnfc.pro @@ -0,0 +1,43 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Aaron McCarthy <mccarthy.aaron@gmail.com> +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:BSD$ +** You may use this file under the terms of the BSD license as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names +** of its contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#! [project modification] +QT += nfc +#! [project modification] diff --git a/src/nfc/doc/snippets/doc_src_qtnfc.qml b/src/nfc/doc/snippets/doc_src_qtnfc.qml new file mode 100644 index 00000000..2cf2488a --- /dev/null +++ b/src/nfc/doc/snippets/doc_src_qtnfc.qml @@ -0,0 +1,44 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Aaron McCarthy <mccarthy.aaron@gmail.com> +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:BSD$ +** You may use this file under the terms of the BSD license as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names +** of its contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +//! [import] +import QtNfc 5.0 +//! [import] + diff --git a/src/nfc/doc/src/examples.qdoc b/src/nfc/doc/src/examples.qdoc new file mode 100644 index 00000000..f49c0d8f --- /dev/null +++ b/src/nfc/doc/src/examples.qdoc @@ -0,0 +1,62 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Aaron McCarthy <mccarthy.aaron@gmail.com> +** 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$ +** +****************************************************************************/ + +/*! +\ingroup all-examples +\page nfc-examples.html +\title Qt NFC Examples +\brief Examples for the QtNfc module + +This is a variety of examples that cover the entire range of the the Qt NFC API. You will find them +in their own documentation but are also accessible from here. + +\section2 C++ Tutorial + +\section2 C++ Examples +\table 80% + \header + \li Example + \li Description + \row + \li \l{annotatedurl}{Annotated URL} + \li Displays URLs stored on NFC Forum Tags. + \row + \li \l{ndefeditor}{NDEF Editor} + \li Create new or modify existing NDEF messages on NFC Forum Tags. +\endtable + +\section2 QML Examples +\table 80% + \header + \li Example + \li Description + \row + \li \l{poster}{QML Poster} + \li Displays URLs stored on NFC Forum Tags. +\endtable +*/ + diff --git a/src/nfc/doc/src/nfc-cpp.qdoc b/src/nfc/doc/src/nfc-cpp.qdoc new file mode 100644 index 00000000..430ca182 --- /dev/null +++ b/src/nfc/doc/src/nfc-cpp.qdoc @@ -0,0 +1,42 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Aaron McCarthy <mccarthy.aaron@gmail.com> +** 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$ +** +****************************************************************************/ +/*! + +\module QtNfc + +\title Qt NFC C++ Classes +\brief An API for accessing NFC Forum Tags and communication with NFC Forum Devices. + +The \l{Qt NFC} C++ API enables an application to access NFC Forum Tags and communication with NFC +Forum Devices. + +To use the C++ library in your application, add the following configuration +option to your \c .pro file: + +\snippet doc_src_qtnfc.pro project modification +*/ + diff --git a/src/nfc/doc/src/nfc-index.qdoc b/src/nfc/doc/src/nfc-index.qdoc new file mode 100644 index 00000000..a3ff0392 --- /dev/null +++ b/src/nfc/doc/src/nfc-index.qdoc @@ -0,0 +1,79 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Aaron McCarthy <mccarthy.aaron@gmail.com> +** 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 qtnfc-index.html +\title Qt NFC +\brief Qt NFC enables connectivity between NFC enabled devices. + +NFC is an extremely short-range (less than 20 centimeters) wireless technology and has a +maximum transfer rate of 424 kbit/s. NFC is ideal for transferring small packets of data when two +devices are touched together. + +The NFC API provides APIs for interacting with NFC Forum Tags and NFC Forum Devices, including +target detection and loss, registering NDEF message handlers, reading and writing NDEF messages +on NFC Forum Tags, sending tag specific commands, client and server LLCP sockets for bidirectional +communication between two NFC Forum Devices. + +\section1 Getting started + +To use the C++ library in your application, add the following configuration +option to your \c .pro file: + +\snippet doc_src_qtnfc.pro 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_qtnfc.qml import + +\section1 Related information + +\section2 Guides +\list + \li \l {Qt NFC Overview} +\endlist + +\section2 Reference +\list + \li \l {Qt NFC QML Types}{QML Types} + \li \l {Qt NFC C++ Classes}{C++ Classes} +\endlist + +\section2 Examples +\list + \li QML + \list + \li \l {poster}{QML Poster} + \endlist + \li C++ + \list + \li \l {annotatedurl}{Annotated URL} + \li \l {ndefeditor}{NDEF Editor} + \endlist +\endlist +*/ diff --git a/src/nfc/doc/src/nfc-overview.qdoc b/src/nfc/doc/src/nfc-overview.qdoc new file mode 100644 index 00000000..a70972d9 --- /dev/null +++ b/src/nfc/doc/src/nfc-overview.qdoc @@ -0,0 +1,53 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Aaron McCarthy <mccarthy.aaron@gmail.com> +** 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$ +** +****************************************************************************/ + +/*! +\ingroup technology-apis +\title Qt NFC Overview +\page qtnfc-overview.html +\brief The Qt NFC classes provides access to NFC enabled devices. + +\tableofcontents + +With the Qt NFC API typical use cases are: + +\list + \li Detect NFC devices entering and leaving communication range. + \li Read and write NDEF message on NFC Forum Tags. + \li Create an LLCP server listening for incoming LLCP socket connections. + \li Create an LLCP socket connection to a NFC Forum Device. + \li Register an NDEF message handler for a particular content type. +\endlist + +The following sections describe how to use QtNfc C++ classes for the above use cases. + +\section1 Detect NFC devices entering and leaving communication range. +\section1 Read and write NDEF message on NFC Forum Tags. +\section1 Create an LLCP server listening for incoming LLCP socket connections. +\section1 Create an LLCP socket connection to a NFC Forum Device. +\section1 Register an NDEF message handler for a particular content type. +*/ diff --git a/src/nfc/doc/src/nfc-qml.qdoc b/src/nfc/doc/src/nfc-qml.qdoc new file mode 100644 index 00000000..3ed4cc9c --- /dev/null +++ b/src/nfc/doc/src/nfc-qml.qdoc @@ -0,0 +1,42 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Aaron McCarthy <mccarthy.aaron@gmail.com> +** 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$ +** +****************************************************************************/ + + +/*! + +\qmlmodule QtNfc 5.0 +\title Qt NFC QML Types +\ingroup qmlmodules +\brief Provides QML types for accessing NFC Forum Tags and Devices + +To use the classes of the module in your application you need the following +import statement in your \c .qml file: + +\snippet doc_src_qtnfc.qml import + +*/ + diff --git a/src/nfc/nfc.pro b/src/nfc/nfc.pro index 935eb2fc..0adf5420 100644 --- a/src/nfc/nfc.pro +++ b/src/nfc/nfc.pro @@ -3,6 +3,9 @@ QT = core load(qt_module) +QMAKE_DOCS = $$PWD/doc/qtnfc.qdocconf +OTHER_FILES += doc/src/*.qdoc # show .qdoc files in Qt Creator + # All classes in this module are in the QtNfc namespace. Define the namespace which moc generated # code will be in. DEFINES += QT_BEGIN_MOC_NAMESPACE=\""namespace QtNfc {"\" diff --git a/src/nfc/qdeclarativendefrecord.cpp b/src/nfc/qdeclarativendefrecord.cpp index 61abd002..2ddab0dd 100644 --- a/src/nfc/qdeclarativendefrecord.cpp +++ b/src/nfc/qdeclarativendefrecord.cpp @@ -90,7 +90,7 @@ QTNFC_BEGIN_NAMESPACE \brief The NdefRecord type represents a record in an NDEF message. \ingroup nfc-qml - \inmodule QtNfc + \inqmlmodule QtNfc 5.0 \sa NdefFilter \sa NearField |