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
@@ -83,80 +83,80 @@ public:
     wiface = (OWirelessNetworkInterface*) iface;
     printf( "Using wireless interface '%s' for scanning (current SSID is '%s')...\n", (const char*) interface, (const char*) wiface->SSID() );
 
     // ifconfig +promisc the interface to receive all packets
     if ( !wiface->promiscuousMode() )
     {
         printf( "Interface status is not promisc... switching to promisc... " );
         wiface->setPromiscuousMode( true );
         if ( !wiface->promiscuousMode() )
         {
             printf( "failed (%s). Exiting.\n", strerror( errno ) );
             exit( -1 );
         }
         else
         {
             printf( "ok.\n" );
         }
     }
     else
         printf( "Interface status is already promisc - good.\n" );
 
     // connect a monitoring strategy to the interface
     if ( driver == "orinoco" )
         new OOrinocoMonitoringInterface( wiface );
     else
     {
         printf( "Unknown driver. Exiting\n" );
         exit( -1 );
     }
 
     // enable monitoring mode
     printf( "Enabling monitor mode...\n" );
-    wiface->setMonitorMode( true );
+    //wiface->setMonitorMode( true );
 
     // open a packet capturer
     cap = new OPacketCapturer();
     cap->open( interface );
     if ( !cap->isOpen() )
     {
         printf( "Unable to open libpcap (%s). Exiting.\n", strerror( errno ) );
         exit( -1 );
     }
 
     // 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*) ) );
 
   }
 
   ~Wellenreiter() {};
 
 public slots:
   void receivePacket(OPacket* p)
   {
     if (!p)
     {
         printf( "(empty packet received)\n" );
         return;
     }
 
     OWaveLanManagementPacket* beacon = (OWaveLanManagementPacket*) p->child( "802.11 Management" );
     if ( beacon )
     {
         OWaveLanManagementSSID* ssid = static_cast<OWaveLanManagementSSID*>( p->child( "802.11 SSID" ) );
         QString essid = ssid ? ssid->ID() : "<unknown>";
 
         if ( stations.find( essid ) )
             stations[essid]->beacons++;
         else
         {
             printf( "found new network @ channel %d, SSID = '%s'\n", wiface->channel(), (const char*) essid );
             stations.insert( essid, new Station( "unknown", wiface->channel(),
             ((OWaveLanPacket*) beacon->parent())->usesWep() ) );
         }
         return;
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
@@ -84,65 +84,65 @@ class ONetwork : public QObject
 
  public:
     typedef QDict<ONetworkInterface> InterfaceMap;
     typedef QDictIterator<ONetworkInterface> InterfaceIterator;
 
   public:
     /**
      * @returns the number of available interfaces
      */
     int count() const;
     /**
      * @returns a pointer to the (one and only) @ref ONetwork instance.
      */
     static ONetwork* instance();
     /**
      * @returns an iterator usable for iterating through all network interfaces.
      */
     InterfaceIterator iterator() const;
     /**
      * @returns true, if the @p interface supports the wireless extension protocol.
      */
      // FIXME QString? -zecke
     bool isWirelessInterface( const char* interface ) const;
     /**
      * @returns a pointer to the @ref ONetworkInterface object for the specified @p interface or 0, if not found
      * @see ONetworkInterface
      */
      // FIXME: const QString& is prefered over QString!!! -zecke
     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:
     ONetwork();
 
   private:
     static ONetwork* _instance;
     InterfaceMap _interfaces;
 };
 
 
 /*======================================================================================
  * ONetworkInterface
  *======================================================================================*/
 
 /**
  * @brief A network interface wrapper.
  *
  * This class provides a wrapper for a network interface. All the cumbersume details of
  * Linux ioctls are hidden under a convenient high-level interface.
  * @warning Most of the setting methods contained in this class require the appropriate
  * process permissions to work.
  * @author Michael 'Mickey' Lauer <mickey@tm.informatik.uni-frankfurt.de>
  */
 class ONetworkInterface : public QObject
 {
     friend class OMonitoringInterface;
     friend class OCiscoMonitoringInterface;
     friend class OWlanNGMonitoringInterface;
     friend class OHostAPMonitoringInterface;
     friend class OOrinocoMonitoringInterface;
@@ -224,75 +224,99 @@ class ONetworkInterface : public QObject
     int dataLinkType() const;
 
   protected:
     const int _sfd;
     mutable ifreq _ifr;
     OMonitoringInterface* _mon;
 
   protected:
     struct ifreq& ifr() const;
     virtual void init();
     bool ioctl( int call ) const;
     bool ioctl( int call, struct ifreq& ) const;
 };
 
 /*======================================================================================
  * OChannelHopper
  *======================================================================================*/
 
 /**
  * @brief A radio frequency channel hopper.
  *
  * This class provides a channel hopper for radio frequencies. A channel hopper frequently
  * changes the radio frequency channel of its associated @ref OWirelessNetworkInterface.
  * This is necessary when in monitoring mode and scanning for other devices, because
  * the radio frequency hardware can only detect packets sent on the same frequency.
  * @author Michael 'Mickey' Lauer <mickey@tm.informatik.uni-frankfurt.de>
  */
 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;
     QValueList<int> _channels;
     QValueList<int>::Iterator _channel;
 };
 
 
 /*======================================================================================
  * OWirelessNetworkInterface
  *======================================================================================*/
 
 /**
  * @brief A network interface wrapper for interfaces supporting the wireless extensions protocol.
  *
  * This class provides a high-level encapsulation of the Linux wireless extension API.
  */
 class OWirelessNetworkInterface : public ONetworkInterface
 {
     friend class OMonitoringInterface;
     friend class OCiscoMonitoringInterface;
     friend class OWlanNGMonitoringInterface;
     friend class OHostAPMonitoringInterface;
     friend class OOrinocoMonitoringInterface;
 
     friend class OPrivateIOCTL;
 
   public:
     enum Mode { AdHoc, Managed, Monitor };
 
     /**
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
@@ -124,84 +124,82 @@ class OPacket : public QObject
     int caplen() const;
     int len() const;
     QString dump( int = 32 ) const;
 
     void updateStats( QMap<QString,int>&, QObjectList* );
 
   private:
     const packetheaderstruct _hdr;  // pcap packet header
     const unsigned char* _data;     // pcap packet data
     const unsigned char* _end;      // end of pcap packet data
 };
 
 /*======================================================================================
  * OEthernetPacket - DLT_EN10MB frame
  *======================================================================================*/
 
 class OEthernetPacket : public QObject
 {
   Q_OBJECT
 
   public:
     OEthernetPacket( const unsigned char*, const struct ether_header*, QObject* parent = 0 );
     virtual ~OEthernetPacket();
 
     OMacAddress sourceAddress() const;
     OMacAddress destinationAddress() const;
     int type() const;
 
   private:
     const struct ether_header* _ether;
 };
 
-
 /*======================================================================================
  * OPrismHeaderPacket - DLT_PRISM_HEADER frame
  *======================================================================================*/
 
 class OPrismHeaderPacket : public QObject
 {
   Q_OBJECT
 
   public:
     OPrismHeaderPacket( const unsigned char*, const struct prism_hdr*, QObject* parent = 0 );
     virtual ~OPrismHeaderPacket();
 
     unsigned int signalStrength() const;
 
   private:
     const struct prism_hdr* _header;
 };
 
-
 /*======================================================================================
  * OWaveLanPacket - DLT_IEEE802_11 frame
  *======================================================================================*/
 
 class OWaveLanPacket : public QObject
 {
   Q_OBJECT
 
   public:
     OWaveLanPacket( const unsigned char*, const struct ieee_802_11_header*, QObject* parent = 0 );
     virtual ~OWaveLanPacket();
 
     int duration() const;
     bool fromDS() const;
     bool toDS() const;
     virtual OMacAddress macAddress1() const;
     virtual OMacAddress macAddress2() const;
     virtual OMacAddress macAddress3() const;
     virtual OMacAddress macAddress4() const;
     bool usesPowerManagement() const;
     int type() const;
     int subType() const;
     int version() const;
     bool usesWep() const;
 
   private:
     const struct ieee_802_11_header* _wlanhdr;
 };
 
 
 /*======================================================================================
  * OWaveLanManagementPacket - type: management (T_MGMT)
@@ -323,81 +321,80 @@ class OWaveLanManagementDS : public QObject
 class OWaveLanManagementTim : public QObject
 {
   Q_OBJECT
 
   public:
     OWaveLanManagementTim( const unsigned char*, const struct tim_t*, QObject* parent = 0 );
     virtual ~OWaveLanManagementTim();
 
   private:
     const struct tim_t* _data;
 };
 
 /*======================================================================================
  * OWaveLanManagementIBSS
  *======================================================================================*/
 
 class OWaveLanManagementIBSS : public QObject
 {
   Q_OBJECT
 
   public:
     OWaveLanManagementIBSS( const unsigned char*, const struct ibss_t*, QObject* parent = 0 );
     virtual ~OWaveLanManagementIBSS();
 
   private:
     const struct ibss_t* _data;
 };
 
 /*======================================================================================
  * OWaveLanManagementChallenge
  *======================================================================================*/
 
-// Qobject do we need that??
 class OWaveLanManagementChallenge : public QObject
 {
   Q_OBJECT
 
   public:
     OWaveLanManagementChallenge( const unsigned char*, const struct challenge_t*, QObject* parent = 0 );
     virtual ~OWaveLanManagementChallenge();
 
   private:
     const struct challenge_t* _data;
 };
 
 /*======================================================================================
  * OWaveLanDataPacket - type: data (T_DATA)
  *======================================================================================*/
-// Qobject?
+
 class OWaveLanDataPacket : public QObject
 {
   Q_OBJECT
 
   public:
     OWaveLanDataPacket( const unsigned char*, const struct ieee_802_11_data_header*, OWaveLanPacket* parent = 0 );
     virtual ~OWaveLanDataPacket();
 
   private:
     const struct ieee_802_11_data_header* _header;
 };
 
 /*======================================================================================
  * OWaveLanControlPacket - type: control (T_CTRL)
  *======================================================================================*/
 
 class OWaveLanControlPacket : public QObject
 {
   Q_OBJECT
 
   public:
     OWaveLanControlPacket( const unsigned char*, const struct ieee_802_11_control_header*, OWaveLanPacket* parent = 0 );
     virtual ~OWaveLanControlPacket();
 
   private:
     const struct ieee_802_11_control_header* _header;
 };
 
 /*======================================================================================
  * OLLCPacket - IEEE 802.2 Link Level Control
  *======================================================================================*/
 
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
@@ -1,48 +1,48 @@
 TEMPLATE    = lib
 CONFIG      += qt warn_on debug
 DESTDIR     = $(OPIEDIR)/lib
 HEADERS     = ocompletionbox.h       \
               ocombobox.h            \
               oeditlistbox.h         \
               olineedit.h            \
               olistview.h            \
               oimageeffect.h         \
               opixmapeffect.h        \
               opopupmenu.h           \
               opixmapprovider.h      \
               oselector.h            \
               oversatileview.h       \
               oversatileviewitem.h   \
               #ojanuswidget.h         \
               odialog.h              \
               oseparator.h           \
               otaskbarapplet.h
-              
+
 SOURCES     = ocompletionbox.cpp     \
               ocombobox.cpp          \
               oeditlistbox.cpp       \
               olineedit.cpp          \
               olistview.cpp          \
               oimageeffect.cpp       \
               opixmapeffect.cpp      \
               opopupmenu.cpp         \
               opixmapprovider.cpp    \
               oselector.cpp          \
               oversatileview.cpp     \
               oversatileviewitem.cpp \
               #ojanuswidget.cpp       \
               odialog.cpp            \
-              oseparator.cpp        \
+              oseparator.cpp         \
               otaskbarapplet.cpp
 
 INTERFACES  =
 TARGET      = opieui2
 VERSION     = 1.8.1
 INCLUDEPATH += $(OPIEDIR)/include
 DEPENDPATH  += $(OPIEDIR)/include
 LIBS        += -lopiecore2
 MOC_DIR     = moc
 OBJECTS_DIR = obj
 
 include ( $(OPIEDIR)/include.pro )