summaryrefslogtreecommitdiff
path: root/libopie2
authormickeyl <mickeyl>2003-04-30 18:42:07 (UTC)
committer mickeyl <mickeyl>2003-04-30 18:42:07 (UTC)
commit027458b66cffbfaf07c394a1a622a1f01970e11c (patch) (side-by-side diff)
tree9cfbbfcebf60c2515719c0e9e2957cc18271dbe5 /libopie2
parent30aac378ab13a7dffbd3b6a0978cabc0372cd530 (diff)
downloadopie-027458b66cffbfaf07c394a1a622a1f01970e11c.zip
opie-027458b66cffbfaf07c394a1a622a1f01970e11c.tar.gz
opie-027458b66cffbfaf07c394a1a622a1f01970e11c.tar.bz2
add some more documentation
Diffstat (limited to 'libopie2') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie2/examples/opienet/miniwellenreiter/miniwellenreiter.cpp4
-rw-r--r--libopie2/opienet/onetwork.h30
-rw-r--r--libopie2/opienet/opcap.h5
-rw-r--r--libopie2/opieui/opieui.pro4
4 files changed, 32 insertions, 11 deletions
diff --git a/libopie2/examples/opienet/miniwellenreiter/miniwellenreiter.cpp b/libopie2/examples/opienet/miniwellenreiter/miniwellenreiter.cpp
index f800336..34d32d2 100644
--- a/libopie2/examples/opienet/miniwellenreiter/miniwellenreiter.cpp
+++ b/libopie2/examples/opienet/miniwellenreiter/miniwellenreiter.cpp
@@ -114,3 +114,3 @@ public:
printf( "Enabling monitor mode...\n" );
- wiface->setMonitorMode( true );
+ //wiface->setMonitorMode( true );
@@ -129,3 +129,3 @@ public:
// start channel hopper
- wiface->setChannelHopping( 1000 );
+ //wiface->setChannelHopping( 1000 );
diff --git a/libopie2/opienet/onetwork.h b/libopie2/opienet/onetwork.h
index 2348bbc..f052317 100644
--- a/libopie2/opienet/onetwork.h
+++ b/libopie2/opienet/onetwork.h
@@ -115,3 +115,3 @@ class ONetwork : public QObject
* @note Sometimes it might be useful to call this from client code,
- * e.g. after cardctl insert
+ * e.g. after issuing a cardctl insert
*/
@@ -255,8 +255,26 @@ class OChannelHopper : public QObject
public:
+ /**
+ * Constructor.
+ */
OChannelHopper( OWirelessNetworkInterface* );
+ /**
+ * Destructor.
+ */
virtual ~OChannelHopper();
+ /**
+ * @returns true, if the channel hopper is hopping channels
+ */
bool isActive() const;
+ /**
+ * @returns the last hopped channel
+ */
int channel() const;
- virtual void timerEvent( QTimerEvent* );
- void setInterval( int );
+ /**
+ * Set the channel hopping @a interval.
+ * An interval of 0 deactivates the channel hopper.
+ */
+ void setInterval( int interval );
+ /**
+ * @returns the channel hopping interval
+ */
int interval() const;
@@ -264,4 +282,10 @@ class OChannelHopper : public QObject
signals:
+ /**
+ * This signal is emitted right after the channel hopper performed a hop
+ */
void hopped( int );
+ protected:
+ virtual void timerEvent( QTimerEvent* );
+
private:
diff --git a/libopie2/opienet/opcap.h b/libopie2/opienet/opcap.h
index 83f7115..bee0ca0 100644
--- a/libopie2/opienet/opcap.h
+++ b/libopie2/opienet/opcap.h
@@ -155,3 +155,2 @@ class OEthernetPacket : public QObject
-
/*======================================================================================
@@ -174,3 +173,2 @@ class OPrismHeaderPacket : public QObject
-
/*======================================================================================
@@ -354,3 +352,2 @@ class OWaveLanManagementIBSS : public QObject
-// Qobject do we need that??
class OWaveLanManagementChallenge : public QObject
@@ -370,3 +367,3 @@ class OWaveLanManagementChallenge : public QObject
*======================================================================================*/
-// Qobject?
+
class OWaveLanDataPacket : public QObject
diff --git a/libopie2/opieui/opieui.pro b/libopie2/opieui/opieui.pro
index 996e1a0..aa85955 100644
--- a/libopie2/opieui/opieui.pro
+++ b/libopie2/opieui/opieui.pro
@@ -19,3 +19,3 @@ HEADERS = ocompletionbox.h \
otaskbarapplet.h
-
+
SOURCES = ocompletionbox.cpp \
@@ -34,3 +34,3 @@ SOURCES = ocompletionbox.cpp \
odialog.cpp \
- oseparator.cpp \
+ oseparator.cpp \
otaskbarapplet.cpp