Add apie comments

QString -> const QString& fix

14 files changed, 51 insertions, 19 deletions

diff --git a/libopie2/opiecore/oapplication.cpp b/libopie2/opiecore/oapplication.cpp
index d3e04ba..ce26420 100644
--- a/libopie2/opiecore/oapplication.cpp
+++ b/libopie2/opiecore/oapplication.cpp
@@ -106,17 +106,17 @@ void OApplication::showMainWidget( QWidget* widget, bool nomax )
     #else
     QApplication::setMainWidget( widget );
     widget->show();
     #endif
     widget->setCaption( _appname );
 }
 
 
-void OApplication::setTitle( QString title ) const
+void OApplication::setTitle( const QString& title ) const
 {
     if ( mainWidget() )
     {
         if ( !title.isNull() )
             mainWidget()->setCaption( QString(_appname) + QString( " - " ) + title );
         else
             mainWidget()->setCaption( _appname );
     }
diff --git a/libopie2/opiecore/oapplication.h b/libopie2/opiecore/oapplication.h
index 4d25202..8326847 100644
--- a/libopie2/opiecore/oapplication.h
+++ b/libopie2/opiecore/oapplication.h
@@ -28,29 +28,33 @@
                              Boston, MA 02111-1307, USA.
 */
 
 #ifndef OAPPLICATION_H
 #define OAPPLICATION_H
 
 #define oApp OApplication::oApplication()
 
+// the below stuff will fail with moc because moc does not pre process headers
+// This will make usage of signal and slots hard inside QPEApplication -zecke
+
 #ifdef QWS
  #include <qpe/qpeapplication.h>
  #define OApplicationBaseClass QPEApplication
 #else
  #include <qapplication.h>
  #define OApplicationBaseClass QApplication
 #endif
 
 class OApplicationPrivate;
 class OConfig;
 
 class OApplication: public OApplicationBaseClass
 {
+// Q_OBJECT would fail -zecke 
   public:
 
    /**
     * Constructor. Parses command-line arguments and sets the window caption.
     *
     * @param rAppName application name. Will be used for finding the
     * associated message, icon and configuration files
     *
@@ -109,17 +113,17 @@ class OApplication: public OApplicationBaseClass
     virtual void showMainWidget( QWidget* widget, bool nomax = false );
 
    /**
     * Set the application title. The application title will be concatenated
     * to the application name given in the constructor.
     *
     * @param title the title. If not given, resets caption to appname
     */
-    virtual void setTitle( QString title = QString::null ) const;
+    virtual void setTitle( const QString& title = QString::null ) const;
     //virtual void setTitle() const;
 
   protected:
     void init();
 
   private:
     const QCString _appname;
     static OApplication* _instance;
diff --git a/libopie2/opiecore/oglobal.h b/libopie2/opiecore/oglobal.h
index 8345c6a..34f211e 100644
--- a/libopie2/opiecore/oglobal.h
+++ b/libopie2/opiecore/oglobal.h
@@ -32,17 +32,18 @@
 #define OGLOBAL_H
 
 #include <qpe/global.h>
 #include <opie2/oconfig.h>
 
 static OConfig globalconfig = OConfig( "global" );
 
 //FIXME: Is it wise or even necessary to inherit OGlobal from Global?
+// once we totally skip libqpe it should ideally swallow Global -zecke
 
 class OGlobal : public Global
 {
   public:
-  
+    // do we want to put that into OApplication as in KApplication -zecke
     static OConfig* config();
 };
 
 #endif // OGLOBAL_H
diff --git a/libopie2/opiecore/oglobalsettings.h b/libopie2/opiecore/oglobalsettings.h
index 6481251..d3f357e 100644
--- a/libopie2/opiecore/oglobalsettings.h
+++ b/libopie2/opiecore/oglobalsettings.h
@@ -42,16 +42,17 @@
 #define OPIE_DEFAULT_CHANGECURSOR true
 #define OPIE_DEFAULT_LARGE_CURSOR false
 #define OPIE_DEFAULT_VISUAL_ACTIVATE true
 #define OPIE_DEFAULT_VISUAL_ACTIVATE_SPEED 50
 
 //FIXME: There's still a whole lot of stuff in here which has to be revised
 //FIXME: before public usage... lack of time to do it at once - so it will
 //FIXME: happen step-by-step. ML.
+// we should not habe too much configure options!!!!!! -zecke
 
 /**
  * Access the OPIE global configuration settings.
  *
  */
 class OGlobalSettings
 {
   public:
@@ -94,31 +95,33 @@ class OGlobalSettings
      *          d->dragCopy();
      *       }
      *    }
      * }
      * </pre>
      *
      */
 
+    // we do not support DND at the momemt -zecke
     static int dndEventDelay();
 
     /**
      * Returns whether OPIE runs in single (default) or double click
      * mode.
      *
      * @return @p true if single click mode, or @p false if double click mode.
      *
      * see @ref http://opie.handhelds.org/documentation/standards/opie/style/mouse/index.html
      **/
     static bool singleClick();
 
     /**
      * Returns whether tear-off handles are inserted in OPopupMenus.
      **/
+    // would clutter the small screen -zecke
     static bool insertTearOffHandle();
 
     /**
      * @return the OPIE setting for "change cursor over icon"
      */
     static bool changeCursorOverIcon();
 
     /**
@@ -246,26 +249,28 @@ class OGlobalSettings
     /**
      * This returns the current mouse settings.
      */
     static OMouseSettings & mouseSettings();
 
     /**
      * The path to the desktop directory of the current user.
      */
+     // below handled by Global stuff and QPEApplication
     static QString desktopPath() { initStatic(); return *s_desktopPath; }
 
     /**
      * The path to the autostart directory of the current user.
      */
     static QString autostartPath() { initStatic(); return *s_autostartPath; }
 
     /**
-     * The path to the trash directory of the current user.
+     * The path to the trash directory of the current user.    
      */
+     // we do not have that concept -zecke
     static QString trashPath() { initStatic(); return *s_trashPath; }
 
     /**
      * The path where documents are stored of the current user.
      */
     static QString documentPath() { initStatic(); return *s_documentPath; }
 
 
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
@@ -16,16 +16,17 @@
 #ifndef OMANUFACTURERDB_H
 #define OMANUFACTURERDB_H
 
 #include <qmap.h>
 
 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:
     OManufacturerDB();
     virtual ~OManufacturerDB();
 
   private:
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
@@ -45,25 +45,27 @@ class OWirelessNetworkInterface;
 
 /*======================================================================================
  * OMacAddress
  *======================================================================================*/
 
 class OMacAddress
 {
   public:
+    // QString c'tor? -zecke
     OMacAddress( unsigned char* );
     OMacAddress( const unsigned char* );
     OMacAddress( struct ifreq& );
     ~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
     static const OMacAddress& unknown;   // 44:44:44:44:44:44
 
   private:
     unsigned char _bytes[6];
@@ -97,16 +99,17 @@ class OPrivateIOCTL : public QObject
     OPrivateIOCTL( QObject* parent, const char* name, int cmd, int getargs, int setargs );
     ~OPrivateIOCTL();
 
     int numberGetArgs() const;
     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:
     u_int32_t _ioctl;
     u_int16_t _getargs;
     u_int16_t _setargs;
 
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
@@ -103,17 +103,17 @@ void ONetwork::synchronize()
             iface = new ONetworkInterface( this, (const char*) str );
         }
         _interfaces.insert( str, iface );
         s.readLine();
     }
 }
 
 
-ONetworkInterface* ONetwork::interface( QString iface ) const
+ONetworkInterface* ONetwork::interface( const QString& iface ) const
 {
     return _interfaces[iface];
 }
 
 
 ONetwork* ONetwork::instance()
 {
     if ( !_instance ) _instance = new ONetwork();
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
@@ -93,22 +93,24 @@ class ONetwork : public QObject
     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
      */
-    ONetworkInterface* interface( QString interface ) const;
+     // FIXME: const QString& is prefered over QString!!! -zecke
+    ONetworkInterface* interface( const QString& interface ) const;
 
   protected:
     ONetwork();
     void synchronize();
 
   private:
     static ONetwork* _instance;
     InterfaceMap _interfaces;
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
@@ -63,17 +63,17 @@ typedef struct pcap_pkthdr packetheaderstruct;
 
 /* FORWARDS */
 class OPacketCapturer;
 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
 
   public:
     OPacket( int datalink, packetheaderstruct, const unsigned char*, QObject* parent );
     virtual ~OPacket();
 
@@ -90,16 +90,17 @@ class OPacket : public QObject
     const unsigned char* _data;     // pcap packet data
     const unsigned char* _end;      // end of pcap packet data
 };
 
 /*======================================================================================
  * OEthernetPacket - DLT_EN10MB frame
  *======================================================================================*/
 
+//FIXME same critic as above -zecke
 class OEthernetPacket : public QObject
 {
   Q_OBJECT
 
   public:
     OEthernetPacket( const unsigned char*, const struct ether_header*, QObject* parent = 0 );
     virtual ~OEthernetPacket();
 
@@ -110,17 +111,17 @@ class OEthernetPacket : public QObject
   private:
     const struct ether_header* _ether;
 };
 
 
 /*======================================================================================
  * OWaveLanPacket - DLT_IEEE802_11 frame
  *======================================================================================*/
-
+//FIXME same
 class OWaveLanPacket : public QObject
 {
   Q_OBJECT
 
   public:
     OWaveLanPacket( const unsigned char*, const struct ieee_802_11_header*, QObject* parent = 0 );
     virtual ~OWaveLanPacket();
 
@@ -140,17 +141,17 @@ class OWaveLanPacket : public QObject
   private:
     const struct ieee_802_11_header* _wlanhdr;
 };
 
 
 /*======================================================================================
  * OWaveLanManagementPacket - type: management (T_MGMT)
  *======================================================================================*/
-
+//FIXME same as above -zecke
 class OWaveLanManagementPacket : public QObject
 {
   Q_OBJECT
 
   public:
     OWaveLanManagementPacket( const unsigned char*, const struct ieee_802_11_mgmt_header*, OWaveLanPacket* parent = 0 );
     virtual ~OWaveLanManagementPacket();
 
@@ -169,17 +170,17 @@ class OWaveLanManagementPacket : public QObject
     const struct ieee_802_11_mgmt_header* _header;
     const struct ieee_802_11_mgmt_body* _body;
 };
 
 
 /*======================================================================================
  * OWaveLanManagementSSID
  *======================================================================================*/
-
+//FIXME is QObject necessary? -zecke
 class OWaveLanManagementSSID : public QObject
 {
   Q_OBJECT
 
   public:
     OWaveLanManagementSSID( const unsigned char*, const struct ssid_t*, QObject* parent = 0 );
     virtual ~OWaveLanManagementSSID();
 
@@ -187,65 +188,67 @@ class OWaveLanManagementSSID : public QObject
 
   private:
     const struct ssid_t* _data;
 };
 
 /*======================================================================================
  * OWaveLanManagementRates
  *======================================================================================*/
-
+// FIXME same as above -zecke
 class OWaveLanManagementRates : public QObject
 {
   Q_OBJECT
 
   public:
     OWaveLanManagementRates( const unsigned char*, const struct rates_t*, QObject* parent = 0 );
     virtual ~OWaveLanManagementRates();
 
   private:
     const struct rates_t* _data;
 };
 
 /*======================================================================================
  * OWaveLanManagementCF
  *======================================================================================*/
 
+//FIXME same....
 class OWaveLanManagementCF : public QObject
 {
   Q_OBJECT
 
   public:
     OWaveLanManagementCF( const unsigned char*, const struct cf_t*, QObject* parent = 0 );
     virtual ~OWaveLanManagementCF();
 
   private:
     const struct cf_t* _data;
 };
 
 /*======================================================================================
  * OWaveLanManagementFH
  *======================================================================================*/
 
+//FIXME same
 class OWaveLanManagementFH : public QObject
 {
   Q_OBJECT
 
   public:
     OWaveLanManagementFH( const unsigned char*, const struct fh_t*, QObject* parent = 0 );
     virtual ~OWaveLanManagementFH();
 
   private:
     const struct fh_t* _data;
 };
 
 /*======================================================================================
  * OWaveLanManagementDS
  *======================================================================================*/
-
+//FIXME same
 class OWaveLanManagementDS : public QObject
 {
   Q_OBJECT
 
   public:
     OWaveLanManagementDS( const unsigned char*, const struct ds_t*, QObject* parent = 0 );
     virtual ~OWaveLanManagementDS();
 
@@ -254,112 +257,118 @@ class OWaveLanManagementDS : public QObject
   private:
     const struct ds_t* _data;
 };
 
 /*======================================================================================
  * OWaveLanManagementTim
  *======================================================================================*/
 
+//FIXME guess what?
 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
  *======================================================================================*/
 
+//FIXME same as above ( Qobject )
 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)
  *======================================================================================*/
-
+// Qobject needed?
 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
  *======================================================================================*/
 
+// QObject needed?
 class OLLCPacket : public QObject
 {
   Q_OBJECT
 
   public:
     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
 
   public:
     OIPPacket( const unsigned char*, const struct iphdr*, QObject* parent = 0 );
     virtual ~OIPPacket();
 
@@ -376,17 +385,17 @@ class OIPPacket : public QObject
 
   private:
     const struct iphdr* _iphdr;
 };
 
 /*======================================================================================
  * OUDPPacket
  *======================================================================================*/
-
+// QObject?
 class OUDPPacket : public QObject
 {
   Q_OBJECT
 
   public:
     OUDPPacket( const unsigned char*, const struct udphdr*, QObject* parent = 0 );
     virtual ~OUDPPacket();
 
@@ -396,16 +405,17 @@ class OUDPPacket : public QObject
   private:
     const struct udphdr* _udphdr;
 };
 
 /*======================================================================================
  * OTCPPacket
  *======================================================================================*/
 
+// Qobect needed?
 class OTCPPacket : public QObject
 {
   Q_OBJECT
 
   public:
     OTCPPacket( const unsigned char*, const struct tcphdr*, QObject* parent = 0 );
     virtual ~OTCPPacket();
 
diff --git a/libopie2/opieui/odialog.h b/libopie2/opieui/odialog.h
index 7947dfb..4116ed7 100644
--- a/libopie2/opieui/odialog.h
+++ b/libopie2/opieui/odialog.h
@@ -46,16 +46,17 @@ class QLayoutItem;
  * 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>
  */
+ // lets fix up Qt instead! Size does matter. -zecke
 
 class ODialog : public QDialog
 {
   Q_OBJECT
 
   public:
 
     /**
@@ -76,13 +77,13 @@ class ODialog : public QDialog
      * widgets inside a dialog according to the KDE standard.
      */
     static int spacingHint();
 
   private:
     static int mMarginSize;
     static int mSpacingSize;
 
-    //class ODialogPrivate;
-    //ODialogPrivate *d;
+    class ODialogPrivate;
+    ODialogPrivate *d; // d pointer always needed! -zecke
 
 };
 #endif // ODIALOG_H
diff --git a/libopie2/opieui/oimageeffect.h b/libopie2/opieui/oimageeffect.h
index 313ea50..fb4d22d 100644
--- a/libopie2/opieui/oimageeffect.h
+++ b/libopie2/opieui/oimageeffect.h
@@ -1,10 +1,11 @@
 //FIXME: Revise for Opie - do we really need such fancy stuff on PDA's?
 //FIXME: Maybe not on SL5xxx, but surely on C700 :))
+//FIXME: I think we don#t need that -zecke
 
 /* This file is part of the KDE libraries
  Copyright (C) 1998, 1999, 2001, 2002 Daniel M. Duley <mosfet@interaccess.com>
  (C) 1998, 1999 Christian Tibirna <ctibirna@total.net>
  (C) 1998, 1999 Dirk A. Mueller <mueller@kde.org>
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
diff --git a/libopie2/opieui/olistview.h b/libopie2/opieui/olistview.h
index bafc67c..b62e278 100644
--- a/libopie2/opieui/olistview.h
+++ b/libopie2/opieui/olistview.h
@@ -114,29 +114,29 @@ class OListViewItem;
     const QPen& columnSeparator() const;
 
    /**
     * create a list view item as child of this object
     * @return the new object
     */
     virtual OListViewItem* childFactory();
 
-    #ifndef QT_NO_DATASTREAM
+#ifndef QT_NO_DATASTREAM
    /**
     * serialize this object to a @ref QDataStream
     * @param s the stream used to serialize this object.
     */
     virtual void serializeTo( QDataStream& s ) const;
 
    /**
     * serialize this object from a @ref QDataStream
     * @param s the stream used to serialize this object.
     */
     virtual void serializeFrom( QDataStream& s );
-    #endif
+#endif
 
   private:
     QColor m_alternateBackground;
     bool m_fullWidth;
     QPen m_columnSeparator;
 };
 
 #ifndef QT_NO_DATASTREAM
diff --git a/libopie2/opieui/opopupmenu.h b/libopie2/opieui/opopupmenu.h
index 94f05f4..54e4301 100644
--- a/libopie2/opieui/opopupmenu.h
+++ b/libopie2/opieui/opopupmenu.h
@@ -1,8 +1,11 @@
+//FIXME what is ODE? ODE Desktop Environemt? -zecke
+//FIXME do we need titles? space is limited that is only eyecandy? -zecke
+//FIXME keyboard navigation is also not that popular on a PDA might be with a keyboard (tuxphone) -zecke
 /* This file is part of the ODE libraries
    Copyright (C) 2000 Daniel M. Duley <mosfet@kde.org>
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License version 2 as published by the Free Software Foundation.
 
    This library is distributed in the hope that it will be useful,
diff --git a/libopie2/qt3/opiecore/opair.h b/libopie2/qt3/opiecore/opair.h
index 26f617d..a151127 100644
--- a/libopie2/qt3/opiecore/opair.h
+++ b/libopie2/qt3/opiecore/opair.h
@@ -1,10 +1,11 @@
 // QPair minus QT_INLINE_TEMPLATE (instead directly using 'inline' directive)
 //FIXME: remove and use qpair.h as soon as we're on Qt3
+// name file qpair -zecke
 
 /****************************************************************************
 **
 ** Definition of QPair class
 **
 **
 ** Copyright (C) 1992-2001 Trolltech AS.  All rights reserved.
 **