Add apie comments

QString -> const QString& fix

5 files changed, 27 insertions, 11 deletions

diff --git a/libopie2/opienet/omanufacturerdb.h b/libopie2/opienet/omanufacturerdb.h
index 5e66c37..cb0b6c8 100644
--- a/libopie2/opienet/omanufacturerdb.h
+++ b/libopie2/opienet/omanufacturerdb.h
@@ -20,8 +20,9 @@
 
 class OManufacturerDB
 {
   public:
+    //FIXME make us consistent -zecke I use self(), sandman inst() you use instance() so we need to chose one!
     static OManufacturerDB* instance();
     const QString& lookup( const QString& macaddr ) const;
 
   protected:
diff --git a/libopie2/opienet/onetutils.h b/libopie2/opienet/onetutils.h
index bedea63..9611518 100644
--- a/libopie2/opienet/onetutils.h
+++ b/libopie2/opienet/onetutils.h
@@ -49,8 +49,9 @@ class OWirelessNetworkInterface;
 
 class OMacAddress
 {
   public:
+    // QString c'tor? -zecke
     OMacAddress( unsigned char* );
     OMacAddress( const unsigned char* );
     OMacAddress( struct ifreq& );
     ~OMacAddress();
@@ -58,8 +59,9 @@ class OMacAddress
     QString manufacturer() const;
     QString toString( bool substitute = false ) const;
     const unsigned char* native() const;
 
+    // no c'tor but this one why not make it a c'tor. it could also replace the others or is this the problem?
     static OMacAddress fromString( const QString& );
 
   public:
     static const OMacAddress& broadcast; // ff:ff:ff:ff:ff:ff
@@ -101,8 +103,9 @@ class OPrivateIOCTL : public QObject
     int typeGetArgs() const;
     int numberSetArgs() const;
     int typeSetArgs() const;
 
+    // FIXME return int? as ::ioctl does? -zecke
     void invoke() const;
     void setParameter( int, u_int32_t );
 
   private:
diff --git a/libopie2/opienet/onetwork.cpp b/libopie2/opienet/onetwork.cpp
index 73b543b..f0094c7 100644
--- a/libopie2/opienet/onetwork.cpp
+++ b/libopie2/opienet/onetwork.cpp
@@ -107,9 +107,9 @@ void ONetwork::synchronize()
     }
 }
 
 
-ONetworkInterface* ONetwork::interface( QString iface ) const
+ONetworkInterface* ONetwork::interface( const QString& iface ) const
 {
     return _interfaces[iface];
 }
 
diff --git a/libopie2/opienet/onetwork.h b/libopie2/opienet/onetwork.h
index d2cc25d..db8e702 100644
--- a/libopie2/opienet/onetwork.h
+++ b/libopie2/opienet/onetwork.h
@@ -97,14 +97,16 @@ class ONetwork : public QObject
     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
      */
-    ONetworkInterface* interface( QString interface ) const;
+     // FIXME: const QString& is prefered over QString!!! -zecke
+    ONetworkInterface* interface( const QString& interface ) const;
 
   protected:
     ONetwork();
     void synchronize();
diff --git a/libopie2/opienet/opcap.h b/libopie2/opienet/opcap.h
index 99631ba..6bf7416 100644
--- a/libopie2/opienet/opcap.h
+++ b/libopie2/opienet/opcap.h
@@ -67,9 +67,9 @@ class QSocketNotifier;
 
 /*======================================================================================
  * OPacket - A frame on the wire
  *======================================================================================*/
-
+// FIXME how many OPackets do we've at a time? QObject seams to be a big for that usage
 class OPacket : public QObject
 {
   Q_OBJECT
 
@@ -94,8 +94,9 @@ class OPacket : public QObject
 /*======================================================================================
  * OEthernetPacket - DLT_EN10MB frame
  *======================================================================================*/
 
+//FIXME same critic as above -zecke
 class OEthernetPacket : public QObject
 {
   Q_OBJECT
 
@@ -114,9 +115,9 @@ class OEthernetPacket : public QObject
 
 /*======================================================================================
  * OWaveLanPacket - DLT_IEEE802_11 frame
  *======================================================================================*/
-
+//FIXME same
 class OWaveLanPacket : public QObject
 {
   Q_OBJECT
 
@@ -144,9 +145,9 @@ class OWaveLanPacket : public QObject
 
 /*======================================================================================
  * OWaveLanManagementPacket - type: management (T_MGMT)
  *======================================================================================*/
-
+//FIXME same as above -zecke
 class OWaveLanManagementPacket : public QObject
 {
   Q_OBJECT
 
@@ -173,9 +174,9 @@ class OWaveLanManagementPacket : public QObject
 
 /*======================================================================================
  * OWaveLanManagementSSID
  *======================================================================================*/
-
+//FIXME is QObject necessary? -zecke
 class OWaveLanManagementSSID : public QObject
 {
   Q_OBJECT
 
@@ -191,9 +192,9 @@ class OWaveLanManagementSSID : public QObject
 
 /*======================================================================================
  * OWaveLanManagementRates
  *======================================================================================*/
-
+// FIXME same as above -zecke
 class OWaveLanManagementRates : public QObject
 {
   Q_OBJECT
 
@@ -208,8 +209,9 @@ class OWaveLanManagementRates : public QObject
 /*======================================================================================
  * OWaveLanManagementCF
  *======================================================================================*/
 
+//FIXME same....
 class OWaveLanManagementCF : public QObject
 {
   Q_OBJECT
 
@@ -224,8 +226,9 @@ class OWaveLanManagementCF : public QObject
 /*======================================================================================
  * OWaveLanManagementFH
  *======================================================================================*/
 
+//FIXME same
 class OWaveLanManagementFH : public QObject
 {
   Q_OBJECT
 
@@ -239,9 +242,9 @@ class OWaveLanManagementFH : public QObject
 
 /*======================================================================================
  * OWaveLanManagementDS
  *======================================================================================*/
-
+//FIXME same
 class OWaveLanManagementDS : public QObject
 {
   Q_OBJECT
 
@@ -258,8 +261,9 @@ class OWaveLanManagementDS : public QObject
 /*======================================================================================
  * OWaveLanManagementTim
  *======================================================================================*/
 
+//FIXME guess what?
 class OWaveLanManagementTim : public QObject
 {
   Q_OBJECT
 
@@ -274,8 +278,9 @@ class OWaveLanManagementTim : public QObject
 /*======================================================================================
  * OWaveLanManagementIBSS
  *======================================================================================*/
 
+//FIXME same as above ( Qobject )
 class OWaveLanManagementIBSS : public QObject
 {
   Q_OBJECT
 
@@ -290,8 +295,9 @@ class OWaveLanManagementIBSS : public QObject
 /*======================================================================================
  * OWaveLanManagementChallenge
  *======================================================================================*/
 
+// Qobject do we need that??
 class OWaveLanManagementChallenge : public QObject
 {
   Q_OBJECT
 
@@ -305,9 +311,9 @@ class OWaveLanManagementChallenge : public QObject
 
 /*======================================================================================
  * OWaveLanDataPacket - type: data (T_DATA)
  *======================================================================================*/
-
+// Qobject?
 class OWaveLanDataPacket : public QObject
 {
   Q_OBJECT
 
@@ -321,9 +327,9 @@ class OWaveLanDataPacket : public QObject
 
 /*======================================================================================
  * OWaveLanControlPacket - type: control (T_CTRL)
  *======================================================================================*/
-
+// Qobject needed?
 class OWaveLanControlPacket : public QObject
 {
   Q_OBJECT
 
@@ -338,8 +344,9 @@ class OWaveLanControlPacket : public QObject
 /*======================================================================================
  * OLLCPacket - IEEE 802.2 Link Level Control
  *======================================================================================*/
 
+// QObject needed?
 class OLLCPacket : public QObject
 {
   Q_OBJECT
 
@@ -347,15 +354,17 @@ class OLLCPacket : public QObject
     OLLCPacket( const unsigned char*, const struct ieee_802_11_802_2_header* data, QObject* parent = 0 );
     virtual ~OLLCPacket();
 
   private:
+  //FIXME how to get that header?
     const struct ieee_802_11_802_2_header* _header;
 };
 
 /*======================================================================================
  * OIPPacket
  *======================================================================================*/
 
+// Qobject as baseclass?
 class OIPPacket : public QObject
 {
   Q_OBJECT
 
@@ -380,9 +389,9 @@ class OIPPacket : public QObject
 
 /*======================================================================================
  * OUDPPacket
  *======================================================================================*/
-
+// QObject?
 class OUDPPacket : public QObject
 {
   Q_OBJECT
 
@@ -400,8 +409,9 @@ class OUDPPacket : public QObject
 /*======================================================================================
  * OTCPPacket
  *======================================================================================*/
 
+// Qobect needed?
 class OTCPPacket : public QObject
 {
   Q_OBJECT