Add basic documentation structure

libnymea-networkmanager/bluetooth/bluetoothserver.cpp

@@ -19,6 +19,15 @@
  *  <http://www.gnu.org/licenses/>.                                        *
  *                                                                         *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+
+/*!
+    \class BluetoothServer
+    \brief Represents a bluetooth LE server for network-manager remote configuration.
+    \inmodule nymea-networkmanager
+    \ingroup networkmanager-bluetooth
+
+*/
+
 #include "bluetoothserver.h"
 #include "../networkmanager.h"
 #include "../networkmanagerutils.h"

libnymea-networkmanager/bluetooth/networkservice.cpp

@@ -20,6 +20,14 @@
  *                                                                         *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
+/*!
+    \class NetworkService
+    \brief Represents a bluetooth LE service interfacing the network-manager.
+    \inmodule nymea-networkmanager
+    \ingroup networkmanager-bluetooth
+
+*/
+
 #include "networkservice.h"
 #include "bluetoothuuids.h"
 

libnymea-networkmanager/bluetooth/wirelessservice.cpp

@@ -20,6 +20,14 @@
  *                                                                         *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
+/*!
+    \class WirelessService
+    \brief Represents a bluetooth LE service interfacing the wireless configuration of the network-manager.
+    \inmodule nymea-networkmanager
+    \ingroup networkmanager-bluetooth
+
+*/
+
 #include "wirelessservice.h"
 #include "bluetoothuuids.h"
 

libnymea-networkmanager/networkconnection.cpp

@@ -20,6 +20,15 @@
  *                                                                         *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
+/*!
+    \class NetworkConnection
+    \brief Represents a network connection configuration.
+    \inmodule nymea-networkmanager
+    \ingroup networkmanager
+
+*/
+
+
 #include "networkconnection.h"
 #include "networkmanagerutils.h"
 

libnymea-networkmanager/networkdevice.cpp

@@ -20,6 +20,15 @@
  *                                                                         *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
+/*!
+    \class NetworkDevice
+    \brief Represents the base class of a network device.
+    \inmodule nymea-networkmanager
+    \ingroup networkmanager
+
+
+*/
+
 /*! \enum NetworkDevice::NetworkDeviceState
     \value NetworkDeviceStateUnknown
     \value NetworkDeviceStateUnmanaged

libnymea-networkmanager/networkmanager.cpp

@@ -20,6 +20,16 @@
  *                                                                         *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
+/*!
+    \class NetworkManager
+    \brief Represents the main network-manager instance.
+    \inmodule nymea-networkmanager
+    \ingroup networkmanager
+
+
+
+*/
+
 #include "networkmanager.h"
 #include "networkconnection.h"
 

libnymea-networkmanager/networksettings.cpp

@@ -20,6 +20,15 @@
  *                                                                         *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
+/*!
+    \class NetworkSettings
+    \brief Represents a setting for a network connection.
+    \inmodule nymea-networkmanager
+    \ingroup networkmanager
+
+
+*/
+
 #include "networksettings.h"
 #include "networkmanagerutils.h"
 

libnymea-networkmanager/wirednetworkdevice.cpp

@@ -20,6 +20,16 @@
  *                                                                         *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
+/*!
+    \class WiredNetworkDevice
+    \brief Represents a wired network device.
+    \inmodule nymea-networkmanager
+    \ingroup networkmanager
+
+
+*/
+
+
 #include "wirednetworkdevice.h"
 
 #include <QDebug>
@@ -70,12 +80,12 @@ void WiredNetworkDevice::setMacAddress(const QString &macAddress)
     m_macAddress = macAddress;
 }
 
-void WiredNetworkDevice::setBitRate(const int &bitRate)
+void WiredNetworkDevice::setBitRate(int bitRate)
 {
     m_bitRate = bitRate;
 }
 
-void WiredNetworkDevice::setPluggedIn(const bool &pluggedIn)
+void WiredNetworkDevice::setPluggedIn(bool pluggedIn)
 {
     m_pluggedIn = pluggedIn;
 }

libnymea-networkmanager/wirednetworkdevice.h

@@ -46,8 +46,8 @@ private:
     bool m_pluggedIn = false;
 
     void setMacAddress(const QString &macAddress);
-    void setBitRate(const int &bitRate);
+    void setBitRate(int bitRate);
-    void setPluggedIn(const bool &pluggedIn);
+    void setPluggedIn(bool pluggedIn);
 
 private slots:
     void propertiesChanged(const QVariantMap &properties);

libnymea-networkmanager/wirelessaccesspoint.cpp

@@ -20,7 +20,16 @@
  *                                                                         *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
-/*! \enum guhserver::WirelessAccessPoint::ApSecurityMode
+/*!
+    \class WirelessAccessPoint
+    \brief Represents a discovered wireless access point.
+    \inmodule nymea-networkmanager
+    \ingroup networkmanager
+
+
+*/
+
+/*! \enum WirelessAccessPoint::ApSecurityMode
     \value ApSecurityModeNone
     \value ApSecurityModePairWep40
     \value ApSecurityModePairWep104
@@ -97,7 +106,7 @@ double WirelessAccessPoint::frequency() const
     return m_frequency;
 }
 
-void WirelessAccessPoint::setFrequency(const double &frequency)
+void WirelessAccessPoint::setFrequency(double frequency)
 {
     m_frequency = frequency;
 }
@@ -108,13 +117,13 @@ int WirelessAccessPoint::signalStrength() const
     return m_signalStrength;
 }
 
-void WirelessAccessPoint::setSignalStrength(const int &signalStrength)
+void WirelessAccessPoint::setSignalStrength(int signalStrength)
 {
     m_signalStrength = signalStrength;
     emit signalStrengthChanged();
 }
 
-void WirelessAccessPoint::setIsProtected(const bool &isProtected)
+void WirelessAccessPoint::setIsProtected(bool isProtected)
 {
     m_isProtected = isProtected;
 }
@@ -125,13 +134,16 @@ bool WirelessAccessPoint::isProtected() const
     return m_isProtected;
 }
 
-/*! Returns the security flags of this \l{WirelessAccessPoint}. \sa WirelessAccessPoint::ApSecurityModes */
+/*! Returns the security flags of this \l{WirelessAccessPoint}.
+
+    \sa WirelessAccessPoint::ApSecurityModes
+*/
 WirelessAccessPoint::ApSecurityModes WirelessAccessPoint::securityFlags() const
 {
     return m_securityFlags;
 }
 
-void WirelessAccessPoint::setSecurityFlags(const WirelessAccessPoint::ApSecurityModes &securityFlags)
+void WirelessAccessPoint::setSecurityFlags(WirelessAccessPoint::ApSecurityModes securityFlags)
 {
     m_securityFlags = securityFlags;
 }

libnymea-networkmanager/wirelessaccesspoint.h

@@ -75,10 +75,10 @@ private:
 
     void setSsid(const QString &ssid);
     void setMacAddress(const QString &macAddress);
-    void setFrequency(const double &frequency);
+    void setFrequency(double frequency);
-    void setSignalStrength(const int &signalStrength);
+    void setSignalStrength(int signalStrength);
-    void setIsProtected(const bool &isProtected);
+    void setIsProtected(bool isProtected);
-    void setSecurityFlags(const WirelessAccessPoint::ApSecurityModes &securityFlags);
+    void setSecurityFlags(WirelessAccessPoint::ApSecurityModes securityFlags);
 
 signals:
     void signalStrengthChanged();

libnymea-networkmanager/wirelessnetworkdevice.cpp

@@ -20,14 +20,31 @@
  *                                                                         *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
-/*! \fn void WirelessNetworkDevice::bitRateChanged(const int &bitRate);
+/*!
+    \class WirelessNetworkDevice
+    \brief Represents a wireless network device.
+    \inmodule nymea-networkmanager
+    \ingroup networkmanager
+
+
+*/
+
+/*! \enum WirelessNetworkDevice::Mode
+    \value ModeUnknown
+    \value ModeAdhoc
+    \value ModeInfrastructure
+    \value ModeAccessPoint
+
+*/
+
+/*! \fn void WirelessNetworkDevice::bitRateChanged(int bitRate);
     This signal will be emitted when the \a bitRate of this \l{WirelessNetworkDevice} has changed.
 */
 
-/*! \fn void WirelessNetworkDevice::stateChanged(const NetworkDeviceState &state);
+/*! \fn void WirelessNetworkDevice::modeChanged(Mode mode);
-    This signal will be emitted when the current \a state of this \l{WirelessNetworkDevice} has changed.
+    This signal will be emitted when the current \a mode of this \l{WirelessNetworkDevice} has changed.
 
-    \sa NetworkDeviceState
+    \sa WirelessNetworkDevice::Mode
 */