summaryrefslogtreecommitdiffstats
path: root/src/nfc/doc/src/nfc-cpp.qdoc
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/src/nfc-cpp.qdoc
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/src/nfc-cpp.qdoc')
-rw-r--r--src/nfc/doc/src/nfc-cpp.qdoc42
1 files changed, 42 insertions, 0 deletions
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
+*/
+