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
@@ -110,9 +110,9 @@ void OApplication::showMainWidget( QWidget* widget, bool nomax )
     widget->setCaption( _appname );
 }
 
 
-void OApplication::setTitle( QString title ) const
+void OApplication::setTitle( const QString& title ) const
 {
     if ( mainWidget() )
     {
         if ( !title.isNull() )
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
@@ -32,8 +32,11 @@
 #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
@@ -45,8 +48,9 @@ class OApplicationPrivate;
 class OConfig;
 
 class OApplication: public OApplicationBaseClass
 {
+// Q_OBJECT would fail -zecke 
   public:
 
    /**
     * Constructor. Parses command-line arguments and sets the window caption.
@@ -113,9 +117,9 @@ class OApplication: public OApplicationBaseClass
     * 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();
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
@@ -36,13 +36,14 @@
 
 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
@@ -46,8 +46,9 @@
 
 //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.
  *
@@ -98,8 +99,9 @@ class OGlobalSettings
      * </pre>
      *
      */
 
+    // we do not support DND at the momemt -zecke
     static int dndEventDelay();
 
     /**
      * Returns whether OPIE runs in single (default) or double click
@@ -113,8 +115,9 @@ class OGlobalSettings
 
     /**
      * 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"
@@ -250,18 +253,20 @@ class OGlobalSettings
 
     /**
      * 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.
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
 
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
@@ -50,8 +50,9 @@ class QLayoutItem;
  * @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
@@ -80,9 +81,9 @@ class ODialog : public QDialog
   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,6 +1,7 @@
 //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>
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
@@ -118,9 +118,9 @@ class OListViewItem;
     * @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.
     */
@@ -130,9 +130,9 @@ class OListViewItem;
     * 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;
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,4 +1,7 @@
+//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
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,6 +1,7 @@
 // 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