Doc: Fix issues in Wifi module documentation

   - Make QWifiDevice reference appear
   - Fix warnings:
       - Document constructor/destructor for QWifiConfiguration
       - Remove signal documentation unused by qdoc
       - Fix undocumented parameters, \reimp tag

Task-number: QTEE-882
Change-Id: Id53feac755bc9d898fee9cbcbfb52e46b6ae17bb
Reviewed-by: Eirik Aavitsland <eirik.aavitsland@theqtcompany.com>
Reviewed-by: Gatis Paeglis <gatis.paeglis@theqtcompany.com>

3 files changed, 15 insertions, 49 deletions

diff --git a/src/wifi/qwificonfiguration.cpp b/src/wifi/qwificonfiguration.cpp
index 87ef440..42196a2 100644
--- a/src/wifi/qwificonfiguration.cpp
+++ b/src/wifi/qwificonfiguration.cpp
@@ -51,12 +51,18 @@ QWifiConfigurationPrivate::QWifiConfigurationPrivate(QWifiConfiguration *config)
     establishing a connection.
  */
 
+/*!
+    Constructs a configuration object with parent \a parent.
+*/
 QWifiConfiguration::QWifiConfiguration(QObject *parent)
     : QObject(parent)
     , d_ptr(new QWifiConfigurationPrivate(this))
 {
 }
 
+/*!
+    Destroys the configuration object.
+*/
 QWifiConfiguration::~QWifiConfiguration()
 {
     delete d_ptr;
diff --git a/src/wifi/qwifidevice.cpp b/src/wifi/qwifidevice.cpp
index f3eb62b..0e421b7 100644
--- a/src/wifi/qwifidevice.cpp
+++ b/src/wifi/qwifidevice.cpp
@@ -57,8 +57,8 @@ QWifiDevice::~QWifiDevice()
 }
 
 /*!
-    Returns \a true if a device is Wifi capable - Wifi driver and firmware has been
-    successfully loaded by the system, otherwise returns \a false.
+    Returns \c true if a device is Wifi capable - Wifi driver and firmware has been
+    successfully loaded by the system, otherwise returns \c false.
 */
 bool QWifiDevice::wifiSupported()
 {
@@ -117,7 +117,7 @@ QByteArray QWifiDevice::wifiInterfaceName()
 }
 
 /*!
-    A conveniece method to set the Wifi interface name.
+    A conveniece method to set the Wifi interface \a name.
 
     \sa wifiInterfaceName()
  */
diff --git a/src/wifi/qwifimanager.cpp b/src/wifi/qwifimanager.cpp
index db188bf..e971fd1 100644
--- a/src/wifi/qwifimanager.cpp
+++ b/src/wifi/qwifimanager.cpp
@@ -205,7 +205,7 @@ void QWifiManagerPrivate::updateLastError(const QString &error)
     QWifiManager packs the scan results in a list-based data model, which can
     be used with Qt's Model/View classes. Information about a Wifi network can
     be accessed using the QWifiManager::Roles data roles.
- */
+*/
 
 /*!
     \enum QWifiManager::NetworkState
@@ -218,7 +218,7 @@ void QWifiManagerPrivate::updateLastError(const QString &error)
     \value ObtainingIPAddress Requesting IP address from DHCP server
     \value DhcpRequestFailed Could not retrieve IP address
     \value Connected Ready to process network requests
- */
+*/
 
 /*!
     \enum QWifiManager::BackendState
@@ -229,7 +229,7 @@ void QWifiManagerPrivate::updateLastError(const QString &error)
     \value Running Supplicant is initialized and ready to process commands
     \value Terminating Shutting down wireless supplicant
     \value NotRunning Wireless supplicant process is not running
- */
+*/
 
 /*!
     \enum QWifiManager::Roles
@@ -243,51 +243,10 @@ void QWifiManagerPrivate::updateLastError(const QString &error)
     \value WPA2Supported holds whether network access point supports WPA2 security protocol (QString)
     \value WEPSupported holds whether network access point supports WEP security protocol (QString)
     \value WPSSupported holds whether network access point supports WPS security protocol (QString)
- */
-
-/*!
-    \fn QWifiManager::networkStateChanged(NetworkState networkState)
-
-    This signal is emitted whenever the network state changes. The network name
-    for which the signal is emitted, can be obtained from currentSSID.
-
-    \sa NetworkState, currentSSID()
- */
-
-/*!
-    \fn QWifiManager::backendStateChanged(BackendState backendState)
-
-    This signal is emitted whenever the backend state changes.
-
-    \sa start(), stop()
- */
-
-/*!
-    \fn QWifiManager::currentSSIDChanged(string currentSSID)
-
-    This signal is emitted when switching between different Wifi networks.
-
-    \sa start(), stop()
- */
-
-/*!
-    \fn QWifiManager::scanningChanged(bool scanning)
-
-    This signal is emitted when device starts or stops to scan for available Wifi networks.
-
-    \sa isScanning()
- */
-
-/*!
-    \fn QWifiManager::lastErrorChanged(const string error)
-
-    This signal is emitted if some internal process has failed, \a error contains
-    a message on what has failed.
-
-    \sa connect()
- */
+*/
 
 QWifiManager* QWifiManager::m_instance = 0;
+
 /*!
     Returns a singleton instance of QWifiManager.
 */
@@ -458,6 +417,7 @@ QString QWifiManager::lastError() const
     return d->m_lastError;
 }
 
+/*! \reimp */
 bool QWifiManager::event(QEvent *event)
 {
     Q_D(QWifiManager);