implement and document a bunch of missing methods

1 files changed, 37 insertions, 21 deletions

diff --git a/libopie2/opienet/onetwork.h b/libopie2/opienet/onetwork.h
index f052317..a29b29d 100644
--- a/libopie2/opienet/onetwork.h
+++ b/libopie2/opienet/onetwork.h
@@ -36,2 +36,6 @@
 
+/* OPIE */
+
+#include <opie2/onetutils.h>
+
 /* QT */
@@ -44,6 +48,2 @@
 
-/* OPIE */
-
-#include <opie2/onetutils.h>
-
 #ifndef IFNAMSIZ
@@ -102,3 +102,3 @@ class ONetwork : public QObject
     /**
-     * @returns true, if the @p interface supports the wireless extension protocol.
+     * @returns true, if the @a interface supports the wireless extension protocol.
      */
@@ -107,3 +107,3 @@ class ONetwork : public QObject
     /**
-     * @returns a pointer to the @ref ONetworkInterface object for the specified @p interface or 0, if not found
+     * @returns a pointer to the @ref ONetworkInterface object for the specified @a interface or 0, if not found
      * @see ONetworkInterface
@@ -200,3 +200,3 @@ class ONetworkInterface : public QObject
      */
-    QString ipV4Address() const;
+    QString ipV4Address() const; //TODO: make this return an OHostAddress
     /**
@@ -218,3 +218,3 @@ class ONetworkInterface : public QObject
      */
-    QString ipV4Netmask() const;
+    QString ipV4Netmask() const; //TODO: make this return an OHostAddress
     /**
@@ -319,4 +319,2 @@ class OWirelessNetworkInterface : public ONetworkInterface
   public:
-    enum Mode { AdHoc, Managed, Monitor };
-
     /**
@@ -348,7 +346,14 @@ class OWirelessNetworkInterface : public ONetworkInterface
     virtual int channels() const;
-    //virtual double frequency(int) const;
-
-    virtual void setMode( Mode ) {}; //FIXME: Implement and document this
-    virtual bool mode() const {}; //FIXME: Implement and document this
-
+    /**
+     * Set the IEEE 802.11 operation @a mode.
+     * Valid values are <ul><li>adhoc<li>managed<li>monitor<li>master
+     * @warning Not all drivers support the all modes.
+     * @note You might have to change the SSID to get the operation mode change into effect.
+     */
+    virtual void setMode( const QString& mode );
+    /**
+     * @returns the current IEEE 802.11 operation mode.
+     * Possible values are <ul><li>adhoc<li>managed<li>monitor<li>master or <li>unknown
+     */
+    virtual QString mode() const;
     /**
@@ -364,3 +369,3 @@ class OWirelessNetworkInterface : public ONetworkInterface
      */
-    virtual void setMonitorMode( bool );
+    virtual void setMonitorMode( bool ); //FIXME: ==> setMode( "monitor" );
     /**
@@ -368,3 +373,3 @@ class OWirelessNetworkInterface : public ONetworkInterface
      */
-    virtual bool monitorMode() const;
+    virtual bool monitorMode() const;  //FIXME: ==> mode()
     /**
@@ -385,3 +390,3 @@ class OWirelessNetworkInterface : public ONetworkInterface
      */
-    virtual void setNickName( const QString& nickname ) {}; //FIXME: Implement this
+    virtual void setNickName( const QString& nickname );
     /**
@@ -402,5 +407,16 @@ class OWirelessNetworkInterface : public ONetworkInterface
     virtual bool isAssociated() const {}; //FIXME: Implement and document this
-    virtual QString associatedAP() const; //FIXME: Implement and document this
-
-    virtual void setSSID( const QString& );
+    /**
+     * @returns the MAC address of the Access Point if the
+     * device is in infrastructure mode. @returns a (more or less random) CELL
+     * address if the device is in adhoc mode.
+     */
+    virtual QString associatedAP() const;
+    /**
+     * Set the @a ssid (Service Set ID) string. This is used to decide
+     * which network to associate with (use "any" to let the driver decide).
+     */
+    virtual void setSSID( const QString& ssid );
+    /**
+     * @returns the current SSID (Service Set ID).
+     */
     virtual QString SSID() const;