summaryrefslogtreecommitdiff
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
parent30aac378ab13a7dffbd3b6a0978cabc0372cd530 (diff)
downloadopie-027458b66cffbfaf07c394a1a622a1f01970e11c.zip
opie-027458b66cffbfaf07c394a1a622a1f01970e11c.tar.gz
opie-027458b66cffbfaf07c394a1a622a1f01970e11c.tar.bz2
add some more documentation
Diffstat (more/less context) (show 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.pro0
4 files changed, 30 insertions, 9 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
@@ -113,5 +113,5 @@ public:
// enable monitoring mode
printf( "Enabling monitor mode...\n" );
- wiface->setMonitorMode( true );
+ //wiface->setMonitorMode( true );
// open a packet capturer
@@ -128,5 +128,5 @@ public:
// start channel hopper
- wiface->setChannelHopping( 1000 );
+ //wiface->setChannelHopping( 1000 );
// connect
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
@@ -114,5 +114,5 @@ class ONetwork : public QObject
* @internal Rebuild the internal interface database
* @note Sometimes it might be useful to call this from client code,
- * e.g. after cardctl insert
+ * e.g. after issuing a cardctl insert
*/
void synchronize();
@@ -254,15 +254,39 @@ 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;
signals:
+ /**
+ * This signal is emitted right after the channel hopper performed a hop
+ */
void hopped( int );
+ protected:
+ virtual void timerEvent( QTimerEvent* );
+
private:
OWirelessNetworkInterface* _iface;
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
@@ -154,5 +154,4 @@ class OEthernetPacket : public QObject
};
-
/*======================================================================================
* OPrismHeaderPacket - DLT_PRISM_HEADER frame
@@ -173,5 +172,4 @@ class OPrismHeaderPacket : public QObject
};
-
/*======================================================================================
* OWaveLanPacket - DLT_IEEE802_11 frame
@@ -353,5 +351,4 @@ class OWaveLanManagementIBSS : public QObject
*======================================================================================*/
-// Qobject do we need that??
class OWaveLanManagementChallenge : public QObject
{
@@ -369,5 +366,5 @@ class OWaveLanManagementChallenge : public QObject
* OWaveLanDataPacket - type: data (T_DATA)
*======================================================================================*/
-// 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