Document the data roles offered by the BluetoothDiscoveryModel.

Change-Id: Ifba68d1980f6eedd030db38836be5a2d62a224b2
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Fabian Bumberger <fbumberger@rim.com>

1 files changed, 25 insertions, 3 deletions

diff --git a/src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp b/src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp
index 8ec78f85..c2623ba0 100644
--- a/src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp
+++ b/src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp
@@ -63,11 +63,33 @@
     limited to a single service such as a game.
 
     The model roles provided by BluetoothDiscoveryModel are
-    \c service, \c name, \c remoteAddress and \c deviceName.
-    Through the \c service role the BluetoothService can be accessed for more details.
+    \c service, \c name, \c remoteAddress and \c deviceName. The meaning of the roles
+    changes based on the current \l discoveryMode.
 
-    \sa QBluetoothServiceDiscoveryAgent
+    \table
+        \header
+            \li Model role
+            \li Device Discovery
+            \li Service Discovery
+         \row
+            \li \c name
+            \li The device's name and address.
+            \li The service name and the name of the device offering the service. If the device name is empty the devices address will be used.
+         \row
+            \li \c deviceName
+            \li The name of the device.
+            \li The name of the device offering the service.
+         \row
+            \li \c service
+            \li The role is undefined in this mode.
+            \li The \l BluetoothService object describing the discovered service.
+         \row
+            \li \c remoteAddress
+            \li The address of the found device.
+            \li The address of the device offering the service.
+    \endtable
 
+    \sa QBluetoothServiceDiscoveryAgent
 */
 
 class QDeclarativeBluetoothDiscoveryModelPrivate