add some more documentation

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
@@ -111,9 +111,9 @@ public:
     }
 
     // enable monitoring mode
     printf( "Enabling monitor mode...\n" );
-    wiface->setMonitorMode( true );
+    //wiface->setMonitorMode( true );
 
     // open a packet capturer
     cap = new OPacketCapturer();
     cap->open( interface );
@@ -126,9 +126,9 @@ public:
     // set capturer to non-blocking mode
     cap->setBlocking( false );
 
     // start channel hopper
-    wiface->setChannelHopping( 1000 );
+    //wiface->setChannelHopping( 1000 );
 
     // connect
     connect( cap, SIGNAL( receivedPacket(OPacket*) ), this, SLOT( receivePacket(OPacket*) ) );
 
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
@@ -112,9 +112,9 @@ class ONetwork : public QObject
     ONetworkInterface* interface( const QString& interface ) const;
     /**
      * @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();
 
   protected:
@@ -252,19 +252,43 @@ class OChannelHopper : public QObject
 {
   Q_OBJECT
 
   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;
     int _interval;
     int _tid;
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
@@ -152,9 +152,8 @@ class OEthernetPacket : public QObject
   private:
     const struct ether_header* _ether;
 };
 
-
 /*======================================================================================
  * OPrismHeaderPacket - DLT_PRISM_HEADER frame
  *======================================================================================*/
 
@@ -171,9 +170,8 @@ class OPrismHeaderPacket : public QObject
   private:
     const struct prism_hdr* _header;
 };
 
-
 /*======================================================================================
  * OWaveLanPacket - DLT_IEEE802_11 frame
  *======================================================================================*/
 
@@ -351,9 +349,8 @@ class OWaveLanManagementIBSS : public QObject
 /*======================================================================================
  * OWaveLanManagementChallenge
  *======================================================================================*/
 
-// Qobject do we need that??
 class OWaveLanManagementChallenge : public QObject
 {
   Q_OBJECT
 
@@ -367,9 +364,9 @@ class OWaveLanManagementChallenge : public QObject
 
 /*======================================================================================
  * OWaveLanDataPacket - type: data (T_DATA)
  *======================================================================================*/
-// Qobject?
+
 class OWaveLanDataPacket : public QObject
 {
   Q_OBJECT
 
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
@@ -16,9 +16,9 @@ HEADERS     = ocompletionbox.h       \
               #ojanuswidget.h         \
               odialog.h              \
               oseparator.h           \
               otaskbarapplet.h
-              
+
 SOURCES     = ocompletionbox.cpp     \
               ocombobox.cpp          \
               oeditlistbox.cpp       \
               olineedit.cpp          \
@@ -31,9 +31,9 @@ SOURCES     = ocompletionbox.cpp     \
               oversatileview.cpp     \
               oversatileviewitem.cpp \
               #ojanuswidget.cpp       \
               odialog.cpp            \
-              oseparator.cpp        \
+              oseparator.cpp         \
               otaskbarapplet.cpp
 
 INTERFACES  =
 TARGET      = opieui2