summaryrefslogtreecommitdiffstats
path: root/src/nfc/doc
diff options
context:
space:
mode:
authorAaron McCarthy <mccarthy.aaron@gmail.com>2012-10-08 22:43:52 +1000
committerAaron McCarthy <mccarthy.aaron@gmail.com>2013-01-30 12:23:50 +0100
commita9609faf443103756a06bce434ad600e7104c1aa (patch)
treeaffff43425379927bf5eb9357e6ac8d4aefa3624 /src/nfc/doc
parent318e889fd4c61336d658f419fb686bde3c3d06e3 (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/nfc/doc')
-rw-r--r--src/nfc/doc/qtnfc.qdocconf50
-rw-r--r--src/nfc/doc/snippets/doc_src_qtnfc.cpp48
-rw-r--r--src/nfc/doc/snippets/doc_src_qtnfc.pro43
-rw-r--r--src/nfc/doc/snippets/doc_src_qtnfc.qml44
-rw-r--r--src/nfc/doc/src/examples.qdoc62
-rw-r--r--src/nfc/doc/src/nfc-cpp.qdoc42
-rw-r--r--src/nfc/doc/src/nfc-index.qdoc79
-rw-r--r--src/nfc/doc/src/nfc-overview.qdoc53
-rw-r--r--src/nfc/doc/src/nfc-qml.qdoc42
9 files changed, 463 insertions, 0 deletions
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
+
+*/
+