[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-commits
Subject: [libnm-qt] /: some docu fixes while reading the code
From: Lukas Tinkl <lukas () kde ! org>
Date: 2011-10-31 18:32:32
Message-ID: 20111031183232.EF5E0A60A6 () git ! kde ! org
[Download RAW message or body]
Git commit db4fce1c7c7fec8ceb69e60f551661eeef2690e5 by Lukas Tinkl.
Committed on 31/10/2011 at 19:32.
Pushed by lukas into branch 'master'.
some docu fixes while reading the code
M +2 -2 bluetoothdevice.h
M +4 -4 device.h
M +3 -3 manager.h
M +1 -1 olpcmeshdevice.cpp
M +3 -3 olpcmeshdevice.h
M +5 -5 wimaxdevice.h
M +4 -4 wirelessdevice.h
M +3 -3 wirelessnetwork.h
http://commits.kde.org/libnm-qt/db4fce1c7c7fec8ceb69e60f551661eeef2690e5
diff --git a/bluetoothdevice.h b/bluetoothdevice.h
index 45fe23b..b39d21c 100644
--- a/bluetoothdevice.h
+++ b/bluetoothdevice.h
@@ -76,9 +76,9 @@ public:
/**
* The NetworkInterface type.
*
- * @return the NetworkInterface::Type. This always returns NetworkInt=
erface::Bluetooth
+ * @return the NetworkManager::Device::Type. This always returns Netw=
orkManager::Device::Bluetooth
*/
- virtual NetworkManager::Device::Type type() const;
+ virtual Type type() const;
=
public Q_SLOTS:
void btPropertiesChanged(const QVariantMap & changedProperties);
diff --git a/device.h b/device.h
index 137198c..688cbb1 100644
--- a/device.h
+++ b/device.h
@@ -149,7 +149,7 @@ public:
* State becoming ACTIVATED.
*/
QString ipInterfaceName() const;
- /*
+ /**
* Handle for the system driver controlling this network interface
*/
QString driver() const;
@@ -178,7 +178,7 @@ public:
bool isActive() const;
/**
* Retrieves the current state of the device.
- * Tthis a high level view of the device. It is user oriented, so
+ * This is a high level view of the device. It is user oriented, so
* actually it provides state coming from different layers.
*
* @return the current connection state
@@ -227,8 +227,8 @@ Q_SIGNALS:
/**
* This signal is emitted when the device's link status changed.
*
- * @param new_state the new state of the connection
- * @param old_state the previous state of the connection
+ * @param newstate the new state of the connection
+ * @param oldstate the previous state of the connection
* @param reason the reason for the state change, if any. ReasonNone =
where the backend
* provides no reason.
* @see Device::State
diff --git a/manager.h b/manager.h
index 7eb8f6d..96603b1 100644
--- a/manager.h
+++ b/manager.h
@@ -189,20 +189,20 @@ namespace NetworkManager {
*/
NMQT_EXPORT bool isWimaxHardwareEnabled();
/**
- * @param deviceUni unique identifier of the network interface to be a=
ctivated
+ * @param interfaceUni unique identifier of the network interface to b=
e activated
* @param connectionUni unique identifier for the connection to be act=
ivated
* @param connectionParameter can be used to specify extra parameters =
not specific to the NetworkInterface or the connection, eg which AP to use =
when several present with same ESSID in range (because ESSID does not guara=
ntee that the AP is part of the network you want to join!)
*/
NMQT_EXPORT void activateConnection(const QString & interfaceUni, cons=
t QString & connectionUni, const QString & connectionParameter);
/**
- * @param deviceUni unique identifier of the network interface to be a=
ctivated
+ * @param interfaceUni unique identifier of the network interface to b=
e activated
* @param connection connection to be added and activated
* @param connectionParameter can be used to specify extra parameters =
not specific to the NetworkInterface or the connection, eg which AP to use =
when several present with same ESSID in range (because ESSID does not guara=
ntee that the AP is part of the network you want to join!)
*/
NMQT_EXPORT void addAndActivateConnection(const QString & interfaceUni=
, const QVariantMapMap & connection, const QString & connectionParameter);
/**
* Deactivate this network interface, if active
- * @param activeConnectionUni identifer of the connection to deactivate
+ * @param activeConnection identifer of the connection to deactivate
*/
NMQT_EXPORT void deactivateConnection(const QString & activeConnection=
);
/**
diff --git a/olpcmeshdevice.cpp b/olpcmeshdevice.cpp
index 9e6aa46..3f67365 100644
--- a/olpcmeshdevice.cpp
+++ b/olpcmeshdevice.cpp
@@ -49,7 +49,7 @@ NetworkManager::OlpcMeshDevice::~OlpcMeshDevice()
=
NetworkManager::Device::Type NetworkManager::OlpcMeshDevice::type() const
{
- return NetworkManager::Device::OlpcMesh;
+ return NetworkManager::Device::OlpcMesh;
}
=
QString NetworkManager::OlpcMeshDevice::hardwareAddress() const
diff --git a/olpcmeshdevice.h b/olpcmeshdevice.h
index b2817c8..d9b6629 100644
--- a/olpcmeshdevice.h
+++ b/olpcmeshdevice.h
@@ -42,13 +42,13 @@ Q_DECLARE_PRIVATE(OlpcMeshDevice)
=
public:
/**
- * Creates a new WimaxDevice object.
+ * Creates a new OlpcMeshDevice object.
*
* @param path the DBus path of the device
*/
OlpcMeshDevice(const QString & path, QObject * parent);
/**
- * Destroys a WimaxDevice object.
+ * Destroys a OlpcMeshDevice object.
*/
~OlpcMeshDevice();
/**
@@ -80,7 +80,7 @@ Q_SIGNALS:
*/
void companionChanged(Device *);
/**
- * The device changed it's hardware address
+ * The device changed its hardware address
*/
void hardwareAddressChanged(const QString &);
};
diff --git a/wimaxdevice.h b/wimaxdevice.h
index 40a1359..ce67ed9 100644
--- a/wimaxdevice.h
+++ b/wimaxdevice.h
@@ -118,23 +118,23 @@ Q_SIGNALS:
*/
void bsidChanged(const QString &);
/**
- * The device changed it's hardware address
+ * The device changed its hardware address
*/
void hardwareAddressChanged(const QString &);
/**
- * The device changed it's center frequency
+ * The device changed its center frequency
*/
void centerFrequencyChanged(uint);
/**
- * The device changed it's signal/noise ratio
+ * The device changed its signal/noise ratio
*/
void cinrChanged(int);
/**
- * The device changed it's RSSI
+ * The device changed its RSSI
*/
void rssiChanged(int);
/**
- * The device changed it's TxPower.
+ * The device changed its TxPower.
*/
void txPowerChanged(int);
/**
diff --git a/wirelessdevice.h b/wirelessdevice.h
index 4e4c47e..41f8400 100644
--- a/wirelessdevice.h
+++ b/wirelessdevice.h
@@ -153,19 +153,19 @@ Q_SIGNALS:
*/
void modeChanged(WirelessDevice::OperationMode);
/**
- * The device changed it's capabilities
+ * The device changed its capabilities
*/
void wirelessCapabilitiesChanged(Capabilities);
/**
- * The device changed it's hardware address
+ * The device changed its hardware address
*/
void hardwareAddressChanged(const QString &);
/**
- * The device changed it's permanent hardware address
+ * The device changed its permanent hardware address
*/
void permanentHardwareAddressChanged(const QString &);
/**
- * The device changed it's capabilities
+ * The device changed its properties
*/
void wirelessPropertiesChanged(uint);
/**
diff --git a/wirelessnetwork.h b/wirelessnetwork.h
index 22e36a6..7551759 100644
--- a/wirelessnetwork.h
+++ b/wirelessnetwork.h
@@ -64,12 +64,12 @@ class NMQT_EXPORT WirelessNetwork : public QObject
Q_SIGNALS:
/**
* Indicate that the signal strength changed
- * @param signal strength as a percentage.
+ * @param strength strength as a percentage.
*/
void signalStrengthChanged(int strength);
/**
* Indicate that the reference access point changed
- * @param apUni new access point or 0 if none
+ * @param apUni new access point or empty string if none
*/
void referenceAccessPointChanged(const QString &apUni);
/**
@@ -77,7 +77,7 @@ Q_SIGNALS:
* (meaning the network has disappeared from view of the network inter=
face)
* @param ssid the SSID of this network
*/
- void disappeared(const QString &);
+ void disappeared(const QString & ssid);
private Q_SLOTS:
void accessPointAppeared(const QString &);
void accessPointDisappeared(const QString &);
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic