diff options
author | Jerome Pasion <jerome.pasion@digia.com> | 2012-09-25 15:20:41 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2012-09-27 14:43:52 +0200 |
commit | d8a179128c0fa8e9cc482df58b9334c696602be6 (patch) | |
tree | dd5032440aa87dfd63c973265adc9947db0918f6 /src/bluetooth/doc/src/bluetooth-qml.qdoc | |
parent | 9d89c661395347bdda9362a77d38c86ad60f486b (diff) |
Qt Bluetooth: Modularized documentation
-moved documentation to src/bluetooth/doc
-added a qdocconf file for Qt Bluetooth
-fixed relative paths for snippets
-moved examples to examples/bluetooth
Change-Id: Id41bac50dca628400568d191f1c3ccfbaac790a1
Reviewed-by: Alex <ablasche@gmail.com>
Diffstat (limited to 'src/bluetooth/doc/src/bluetooth-qml.qdoc')
-rw-r--r-- | src/bluetooth/doc/src/bluetooth-qml.qdoc | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/src/bluetooth/doc/src/bluetooth-qml.qdoc b/src/bluetooth/doc/src/bluetooth-qml.qdoc new file mode 100644 index 00000000..36c4d4fd --- /dev/null +++ b/src/bluetooth/doc/src/bluetooth-qml.qdoc @@ -0,0 +1,54 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** 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$ +** +****************************************************************************/ + + +/*! + +\page bluetooth-qml.html + +\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 + +\list +\annotatedlist bluetooth-qml +\endlist + +*/ + |