Add documentation to QtWifi library

Change-Id: Ifd71c65a155ad296f3491085e91556eb69226b2b
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>

1 files changed, 29 insertions, 0 deletions

diff --git a/src/imports/wifi/pluginmain.cpp b/src/imports/wifi/pluginmain.cpp
index 97f16f3..6b8c0c3 100644
--- a/src/imports/wifi/pluginmain.cpp
+++ b/src/imports/wifi/pluginmain.cpp
@@ -25,6 +25,35 @@
 
 #include <hardware_legacy/wifi.h>
 
+/*!
+    \qmltype Interface
+    \inqmlmodule Qt.labs.wifi
+    \brief The Interface element provides the module API.
+
+    This element cannot be directly created. It can only be accessed via a namespace import.
+
+    \code
+    import Qt.labs.wifi 0.1
+    import Qt.labs.wifi 0.1 as Wifi
+
+    Component.onCompleted: {
+        if (Wifi.Interface.wifiSupported()) {
+            var component = Qt.createComponent("WifiMenu.qml")
+        } else {
+            print("WiFi functionality not available on this device.")
+        }
+    }
+
+    \endcode
+*/
+
+/*!
+    \qmlmethod bool Interface::wifiSupported()
+
+    Returns true if the device is WiFi capable (provides a WiFi driver), otherwise returns false.
+*/
+
+
 class QWifiGlobal : public QObject
 {
     Q_OBJECT