diff --git a/libnymea-networkmanager/bluetooth/bluetoothserver.cpp b/libnymea-networkmanager/bluetooth/bluetoothserver.cpp
index c335f91..22e7844 100644
--- a/libnymea-networkmanager/bluetooth/bluetoothserver.cpp
+++ b/libnymea-networkmanager/bluetooth/bluetoothserver.cpp
@@ -19,6 +19,15 @@
* . *
* *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+
+/*!
+ \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"
diff --git a/libnymea-networkmanager/bluetooth/networkservice.cpp b/libnymea-networkmanager/bluetooth/networkservice.cpp
index cc4c7c8..6455df5 100644
--- a/libnymea-networkmanager/bluetooth/networkservice.cpp
+++ b/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"
diff --git a/libnymea-networkmanager/bluetooth/wirelessservice.cpp b/libnymea-networkmanager/bluetooth/wirelessservice.cpp
index 6b54e80..7e124e7 100644
--- a/libnymea-networkmanager/bluetooth/wirelessservice.cpp
+++ b/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"
diff --git a/libnymea-networkmanager/networkconnection.cpp b/libnymea-networkmanager/networkconnection.cpp
index 040f00d..113d533 100644
--- a/libnymea-networkmanager/networkconnection.cpp
+++ b/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"
diff --git a/libnymea-networkmanager/networkdevice.cpp b/libnymea-networkmanager/networkdevice.cpp
index 1521cd7..ca2fe5d 100644
--- a/libnymea-networkmanager/networkdevice.cpp
+++ b/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
diff --git a/libnymea-networkmanager/networkmanager.cpp b/libnymea-networkmanager/networkmanager.cpp
index 2544a04..d6b9ac0 100644
--- a/libnymea-networkmanager/networkmanager.cpp
+++ b/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"
diff --git a/libnymea-networkmanager/networksettings.cpp b/libnymea-networkmanager/networksettings.cpp
index 25ad349..5e5c140 100644
--- a/libnymea-networkmanager/networksettings.cpp
+++ b/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"
diff --git a/libnymea-networkmanager/wirednetworkdevice.cpp b/libnymea-networkmanager/wirednetworkdevice.cpp
index 8269139..4a9db5c 100644
--- a/libnymea-networkmanager/wirednetworkdevice.cpp
+++ b/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
@@ -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;
}
diff --git a/libnymea-networkmanager/wirednetworkdevice.h b/libnymea-networkmanager/wirednetworkdevice.h
index 3de3b46..dc36623 100644
--- a/libnymea-networkmanager/wirednetworkdevice.h
+++ b/libnymea-networkmanager/wirednetworkdevice.h
@@ -46,8 +46,8 @@ private:
bool m_pluggedIn = false;
void setMacAddress(const QString &macAddress);
- void setBitRate(const int &bitRate);
- void setPluggedIn(const bool &pluggedIn);
+ void setBitRate(int bitRate);
+ void setPluggedIn(bool pluggedIn);
private slots:
void propertiesChanged(const QVariantMap &properties);
diff --git a/libnymea-networkmanager/wirelessaccesspoint.cpp b/libnymea-networkmanager/wirelessaccesspoint.cpp
index 8c8260c..00928f4 100644
--- a/libnymea-networkmanager/wirelessaccesspoint.cpp
+++ b/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;
}
diff --git a/libnymea-networkmanager/wirelessaccesspoint.h b/libnymea-networkmanager/wirelessaccesspoint.h
index 390acbc..4980e14 100644
--- a/libnymea-networkmanager/wirelessaccesspoint.h
+++ b/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 setSignalStrength(const int &signalStrength);
- void setIsProtected(const bool &isProtected);
- void setSecurityFlags(const WirelessAccessPoint::ApSecurityModes &securityFlags);
+ void setFrequency(double frequency);
+ void setSignalStrength(int signalStrength);
+ void setIsProtected(bool isProtected);
+ void setSecurityFlags(WirelessAccessPoint::ApSecurityModes securityFlags);
signals:
void signalStrengthChanged();
diff --git a/libnymea-networkmanager/wirelessnetworkdevice.cpp b/libnymea-networkmanager/wirelessnetworkdevice.cpp
index 17cdcbb..3b2783e 100644
--- a/libnymea-networkmanager/wirelessnetworkdevice.cpp
+++ b/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);
- This signal will be emitted when the current \a state of this \l{WirelessNetworkDevice} has changed.
+/*! \fn void WirelessNetworkDevice::modeChanged(Mode mode);
+ This signal will be emitted when the current \a mode of this \l{WirelessNetworkDevice} has changed.
- \sa NetworkDeviceState
+ \sa WirelessNetworkDevice::Mode
*/