add some more documentation

2 files changed, 28 insertions, 7 deletions

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
 {