diff options
author | Topi Reinio <topi.reinio@digia.com> | 2014-04-01 10:26:24 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@digia.com> | 2014-04-02 14:18:23 +0300 |
commit | f29274610c980b6c2334d47a9552098d7b9e071b (patch) | |
tree | 8f278fb00b335ea6734b156b3c09eee39e47c35e /src/imports | |
parent | 66cf7de33377415dfa7c90c486f4a5b3fa571f8c (diff) |
Doc: Create QML Type reference page
Create a landing page for QtEE-specific QML modules and types.
Ensure it links correctly to WiFi Module documentation, and
add it to TOC.
Change-Id: Ib3edf9ff8e50f11e138a57aabc1f84749ac48e16
Reviewed-by: Gatis Paeglis <gatis.paeglis@digia.com>
Reviewed-by: Eirik Aavitsland <eirik.aavitsland@digia.com>
Diffstat (limited to 'src/imports')
-rw-r--r-- | src/imports/wifi/pluginmain.cpp | 2 | ||||
-rw-r--r-- | src/imports/wifi/qwifimanager.cpp | 7 | ||||
-rw-r--r-- | src/imports/wifi/qwifinetwork.cpp | 3 |
3 files changed, 8 insertions, 4 deletions
diff --git a/src/imports/wifi/pluginmain.cpp b/src/imports/wifi/pluginmain.cpp index 6b8c0c3..fdf07e9 100644 --- a/src/imports/wifi/pluginmain.cpp +++ b/src/imports/wifi/pluginmain.cpp @@ -28,6 +28,7 @@ /*! \qmltype Interface \inqmlmodule Qt.labs.wifi + \ingroup wifi-qmltypes \brief The Interface element provides the module API. This element cannot be directly created. It can only be accessed via a namespace import. @@ -43,7 +44,6 @@ print("WiFi functionality not available on this device.") } } - \endcode */ diff --git a/src/imports/wifi/qwifimanager.cpp b/src/imports/wifi/qwifimanager.cpp index 04faa93..bc4b6fe 100644 --- a/src/imports/wifi/qwifimanager.cpp +++ b/src/imports/wifi/qwifimanager.cpp @@ -122,7 +122,8 @@ public: /*! \qmlmodule Qt.labs.wifi 0.1 \title WiFi Module - \ingroup b2qt-qmlmodules + \ingroup qtee-qmlmodules + \brief Controlling wireless network interfaces. Provides QML types for controlling and accessing information about wireless network interfaces. @@ -139,13 +140,15 @@ public: import Qt.labs.wifi 0.1 as Wifi \endcode + \section1 QML Types */ /*! \qmltype WifiManager \inqmlmodule Qt.labs.wifi - \brief WifiManager provides information about the wifi backend and available networks. + \ingroup wifi-qmltypes + \brief Provides information about the WiFi backend and available networks. This element is the main interface to the WiFi functionality. diff --git a/src/imports/wifi/qwifinetwork.cpp b/src/imports/wifi/qwifinetwork.cpp index 2ff8d7b..38e031c 100644 --- a/src/imports/wifi/qwifinetwork.cpp +++ b/src/imports/wifi/qwifinetwork.cpp @@ -21,7 +21,8 @@ /*! \qmltype WifiNetwork \inqmlmodule Qt.labs.wifi - \brief WifiNetwork represents a single wifi network access point. + \ingroup wifi-qmltypes + \brief Represents a single WiFi network access point. Instances of WifiNetwork cannot be created directly from the QML system, use WifiManager::networks. |