started to document the whole stuff

3 files changed, 161 insertions, 24 deletions

diff --git a/libopie2/opienet/onetwork.h b/libopie2/opienet/onetwork.h
index e249aee..10f52b8 100644
--- a/libopie2/opienet/onetwork.h
+++ b/libopie2/opienet/onetwork.h
@@ -51,182 +51,321 @@
 #endif
 #ifndef IW_MAX_PRIV_DEF
 #define IW_MAX_PRIV_DEF        128
 #endif
 
 // ML: Yeah, I hate to include kernel headers, but it's necessary here
 // ML: Here comes an ugly hack to prevent <linux/wireless.h> including <linux/if.h>
 // ML: which conflicts with the user header <net/if.h>
 // ML: We really a user header for the Wireless Extensions, something like <net/wireless.h>
 // ML: I will drop Jean an mail on that subject
 
 #include <net/if.h>
 #define _LINUX_IF_H
 #include <linux/wireless.h>
 
 class ONetworkInterface;
 class OWirelessNetworkInterface;
 class OChannelHopper;
 class OMonitoringInterface;
 
 /*======================================================================================
  * ONetwork
  *======================================================================================*/
 
+/**
+ * @brief A container class for all network devices.
+ *
+ * This class provides access to all available network devices of your computer.
+ * @author Michael 'Mickey' Lauer <mickey@tm.informatik.uni-frankfurt.de>
+ */
 class ONetwork : public QObject
 {
   Q_OBJECT
 
  public:
     typedef QDict<ONetworkInterface> InterfaceMap;
     typedef QDictIterator<ONetworkInterface> InterfaceIterator;
 
   public:
+    /**
+     * @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;
-    bool isWirelessInterface( const char* ) const;
-    ONetworkInterface* interface( QString ) const;
+    /**
+     * @returns true, if the @p interface supports the wireless extension protocol.
+     */
+    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
+     */
+    ONetworkInterface* interface( QString interface ) const;
 
   protected:
     ONetwork();
     void synchronize();
 
   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;
 
   public:
+    /**
+     * Constructor. Normally you don't create @ref ONetworkInterface objects yourself,
+     * but access them via @ref ONetwork::interface().
+     */
     ONetworkInterface( QObject* parent, const char* name );
+    /**
+     * Destructor.
+     */
     virtual ~ONetworkInterface();
-
-    void setMonitoring( OMonitoringInterface* );
+    /**
+     * Associates a @a monitoring interface with this network interface.
+     * @note This is currently only useful with @ref OWirelessNetworkInterface objects.
+     */
+    void setMonitoring( OMonitoringInterface* monitoring );
+    /**
+     * @returns the currently associated monitoring interface or 0, if no monitoring is associated.
+     */
     OMonitoringInterface* monitoring() const;
+    /**
+     * Setting an interface to promiscuous mode enables the device to receive
+     * all packets on the shared medium - as opposed to packets which are addressed to this interface.
+     */
     bool setPromiscuousMode( bool );
+    /**
+     * @returns true if the interface is set to promiscuous mode.
+     */
     bool promiscuousMode() const;
+    /**
+     * Setting an interface to up enables it to receive packets.
+     */
     bool setUp( bool );
+    /**
+     * @returns true if the interface is up.
+     */
     bool isUp() const;
+    /*
+     * @returns true if the interface is a loopback interface.
+     */
     bool isLoopback() const;
+    /*
+     * @returns true if the interface is featuring supports the wireless extension protocol.
+     */
     bool isWireless() const;
+    /*
+     * @returns the IPv4 address associated with this interface.
+     */
     QString ipV4Address() const;
-    void setMacAddress( const OMacAddress& );
+    /*
+     * Associate the MAC address @a addr with the interface.
+     * @note It can be necessary to shut down the interface prior to calling this method.
+     * @warning This is not supported by all drivers.
+     */
+    void setMacAddress( const OMacAddress& addr );
+    /*
+     * @returns the MAC address associated with this interface.
+     */
     OMacAddress macAddress() const;
+    /*
+     * @returns the data link type currently associated with this interface.
+     * @see #include <net/if_arp.h> for possible values.
+     */
     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
 {
   public:
     OChannelHopper( OWirelessNetworkInterface* );
     virtual ~OChannelHopper();
     bool isActive() const;
     int channel() const;
     virtual void timerEvent( QTimerEvent* );
     void setInterval( int );
     int interval() const;
 
   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 };
 
+    /**
+     * Constructor.
+     */
     OWirelessNetworkInterface( QObject* parent, const char* name );
+    /**
+     * Destructor.
+     */
     virtual ~OWirelessNetworkInterface();
-
-    virtual void setChannel( int ) const;
+    /**
+     * Setting the @a channel of the interface changes the radio frequency (RF)
+     * of the corresponding wireless network device.
+     */
+    virtual void setChannel( int channel ) const;
+    /**
+     * @returns the channel index of the current radio frequency.
+     */
     virtual int channel() const;
+    /**
+     * @returns the current radio frequency (in MHz).
+     */
     virtual double frequency() const;
+    /**
+     * @returns the number of radio frequency channels for the
+     * corresponding wireless network device.
+     * @note European devices usually have 14 channels, while American typically feature 11 channels.
+     */
     virtual int channels() const;
     //virtual double frequency(int) const;
 
-    virtual void setMode( Mode ) {};
-    virtual bool mode() const {};
-
+    virtual void setMode( Mode ) {}; //FIXME: Implement and document this
+    virtual bool mode() const {}; //FIXME: Implement and document this
+
+    /**
+     * Setting the monitor mode on a wireless network interface enables
+     * listening to IEEE 802.11 data and management frames which normally
+     * are handled by the device firmware. This can be used to detect
+     * other wireless network devices, e.g. Access Points or Ad-hoc stations.
+     * @warning Standard wireless network drives don't support the monitor mode.
+     * @warning You need a patched driver for this to work.
+     * @note Enabling the monitor mode is highly driver dependent and requires
+     * the proper @ref OMonitoringInterface to be associated with the interface.
+     * @see OMonitoringInterface
+     */
     virtual void setMonitorMode( bool );
+    /**
+     * @returns true if the device is listening in IEEE 802.11 monitor mode
+     */
     virtual bool monitorMode() const;
-
+    /**
+     * Set the channel hopping @a interval. An @a interval of 0 disables channel hopping.
+     * @see OChannelHopper
+     */
     virtual void setChannelHopping( int interval = 0 );
+    /**
+     * @returns the channel hopping interval or 0, if channel hopping is disabled.
+     */
     virtual int channelHopping() const;
-
-    virtual void setNickName( const QString& ) {};
+    /**
+     * Set the station @a nickname.
+     */
+    virtual void setNickName( const QString& nickname ) {}; //FIXME: Implement this
+    /**
+     * @returns the current station nickname.
+     */
     virtual QString nickName() const;
-
-    virtual void setPrivate( const QString&, int, ... );
-    virtual bool hasPrivate( const QString& );
-    virtual void getPrivate( const QString& );
-
-    virtual bool isAssociated() const {};
-    virtual QString associatedAP() const;
+    /**
+     * Invoke the private IOCTL @a command with a @number of parameters on the network interface.
+     * @see OPrivateIOCTL
+     */
+    virtual void setPrivate( const QString& command, int number, ... );
+    /**
+     * @returns true if the interface is featuring the private IOCTL @command.
+     */
+    virtual bool hasPrivate( const QString& command );
+    virtual void getPrivate( const QString& command ); //FIXME: Implement and document this
+
+    virtual bool isAssociated() const {}; //FIXME: Implement and document this
+    virtual QString associatedAP() const; //FIXME: Implement and document this
 
     virtual void setSSID( const QString& );
     virtual QString SSID() const;
 
   protected:
     void buildChannelList();
     void buildPrivateList();
     virtual void init();
     struct iwreq& iwr() const;
     bool wioctl( int call ) const;
     bool wioctl( int call, struct iwreq& ) const;
 
   protected:
     mutable struct iwreq _iwr;
     QMap<int,int> _channels;
 
   private:
     OChannelHopper* _hopper;
 };
 
 
 /*======================================================================================
  * OMonitoringInterface
  *======================================================================================*/
diff --git a/libopie2/opieui/odialog.h b/libopie2/opieui/odialog.h
index 38f25e8..7947dfb 100644
--- a/libopie2/opieui/odialog.h
+++ b/libopie2/opieui/odialog.h
@@ -42,48 +42,47 @@ class QLayoutItem;
  *
  * The @ref marginHint() and @ref spacingHint() sizes shall be used
  * whenever you layout the interior of a dialog. One special note. If
  * you make your own action buttons (OK, Cancel etc), the space
  * beteween the buttons shall be @ref spacingHint(), whereas the space
  * above, below, to the right and to the left shall be @ref marginHint().
  * If you add a separator line above the buttons, there shall be a
  * @ref marginHint() between the buttons and the separator and a
  * @ref marginHint() above the separator as well.
  *
  * @author Michael 'Mickey' Lauer <mickey@tm.informatik.uni-frankfurt.de>
  */
 
 class ODialog : public QDialog
 {
   Q_OBJECT
 
   public:
 
     /**
      * Constructor.
      *
      * Takes the same arguments as @ref QDialog.
      */
-    ODialog(QWidget *parent = 0, const char *name = 0,
-	    bool modal = false, WFlags f = 0);
+    ODialog(QWidget *parent = 0, const char *name = 0, bool modal = false, WFlags f = 0);
 
     /**
      * Return the number of pixels you shall use between a
      * dialog edge and the outermost widget(s) according to the KDE standard.
      **/
     static int marginHint();
 
     /**
      * Return the number of pixels you shall use between
      * widgets inside a dialog according to the KDE standard.
      */
     static int spacingHint();
 
   private:
     static int mMarginSize;
     static int mSpacingSize;
 
     //class ODialogPrivate;
     //ODialogPrivate *d;
 
 };
 #endif // ODIALOG_H
diff --git a/libopie2/qt3/opiecore/ocompletion.h b/libopie2/qt3/opiecore/ocompletion.h
index 0317c1b..7f28182 100644
--- a/libopie2/qt3/opiecore/ocompletion.h
+++ b/libopie2/qt3/opiecore/ocompletion.h
@@ -129,49 +129,48 @@ public:
  * mode it will be "carp@cs.tu-berlin.de", as that is alphabetically
  * smaller.
  * If setOrder was set to Insertion, "carpdjih@sp.zrz.tu-berlin.de"
  * would be completed in auto-completion-mode, as that was inserted before
  * "carp@cs.tu-berlin.de".
  *
  * You can dynamically update the completable items by removing and adding them
  * whenever you want.
  * For advanced usage, you could even use multiple OCompletion objects. E.g.
  * imagine an editor like kwrite with multiple open files. You could store
  * items of each file in a different OCompletion object, so that you know (and
  * tell the user) where a completion comes from.
  *
  * Note: OCompletion does not work with strings that contain 0x0 characters
  *       (unicode nul), as this is used internally as a delimiter.
  *
  * You may inherit from OCompletion and override @ref makeCompletion() in
  * special cases (like reading directories/urls and then supplying the
  * contents to OCompletion, as OURLCompletion does), but generally, this is
  * not necessary.
  *
  *
  * @short A generic class for completing QStrings
  * @author Carsten Pfeiffer <pfeiffer@kde.org>
- * @version $Id$
  */
 
 class OCompletion : public QObject
 {
     Q_ENUMS( CompOrder )
     Q_PROPERTY( CompOrder order READ order WRITE setOrder )
     Q_PROPERTY( bool ignoreCase READ ignoreCase WRITE setIgnoreCase )
     Q_PROPERTY( QStringList items READ items WRITE setItems )
     Q_OBJECT
 
   public:
     /**
      * Constants that represent the order in which OCompletion performs
      * completion-lookups.
      */
     enum CompOrder { Sorted, Insertion, Weighted };
 
     /**
      * Constructor, nothing special here :)
      */
     OCompletion();
 
     // FIXME: copy constructor, assignment constructor...