summaryrefslogtreecommitdiff
path: root/libopie2
authorzecke <zecke>2003-04-13 16:25:24 (UTC)
committer zecke <zecke>2003-04-13 16:25:24 (UTC)
commitc27d6327b9be5792fa507557f03997a46f32cc26 (patch) (unidiff)
tree3332ed2d1c673a898ba1862276d8688918618d7f /libopie2
parent3e1f225ed1e515c3425361fdc90ac4d5b6d86941 (diff)
downloadopie-c27d6327b9be5792fa507557f03997a46f32cc26.zip
opie-c27d6327b9be5792fa507557f03997a46f32cc26.tar.gz
opie-c27d6327b9be5792fa507557f03997a46f32cc26.tar.bz2
Add apie comments
QString -> const QString& fix
Diffstat (limited to 'libopie2') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie2/opiecore/oapplication.cpp2
-rw-r--r--libopie2/opiecore/oapplication.h6
-rw-r--r--libopie2/opiecore/oglobal.h3
-rw-r--r--libopie2/opiecore/oglobalsettings.h7
-rw-r--r--libopie2/opienet/omanufacturerdb.h1
-rw-r--r--libopie2/opienet/onetutils.h3
-rw-r--r--libopie2/opienet/onetwork.cpp2
-rw-r--r--libopie2/opienet/onetwork.h4
-rw-r--r--libopie2/opienet/opcap.h28
-rw-r--r--libopie2/opieui/odialog.h5
-rw-r--r--libopie2/opieui/oimageeffect.h1
-rw-r--r--libopie2/opieui/olistview.h4
-rw-r--r--libopie2/opieui/opopupmenu.h3
-rw-r--r--libopie2/qt3/opiecore/opair.h1
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
@@ -111,7 +111,7 @@ void OApplication::showMainWidget( QWidget* widget, bool nomax )
111} 111}
112 112
113 113
114void OApplication::setTitle( QString title ) const 114void OApplication::setTitle( const QString& title ) const
115{ 115{
116 if ( mainWidget() ) 116 if ( mainWidget() )
117 { 117 {
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
@@ -33,6 +33,9 @@
33 33
34#define oApp OApplication::oApplication() 34#define oApp OApplication::oApplication()
35 35
36// the below stuff will fail with moc because moc does not pre process headers
37// This will make usage of signal and slots hard inside QPEApplication -zecke
38
36#ifdef QWS 39#ifdef QWS
37 #include <qpe/qpeapplication.h> 40 #include <qpe/qpeapplication.h>
38 #define OApplicationBaseClass QPEApplication 41 #define OApplicationBaseClass QPEApplication
@@ -46,6 +49,7 @@ class OConfig;
46 49
47class OApplication: public OApplicationBaseClass 50class OApplication: public OApplicationBaseClass
48{ 51{
52// Q_OBJECT would fail -zecke
49 public: 53 public:
50 54
51 /** 55 /**
@@ -114,7 +118,7 @@ class OApplication: public OApplicationBaseClass
114 * 118 *
115 * @param title the title. If not given, resets caption to appname 119 * @param title the title. If not given, resets caption to appname
116 */ 120 */
117 virtual void setTitle( QString title = QString::null ) const; 121 virtual void setTitle( const QString& title = QString::null ) const;
118 //virtual void setTitle() const; 122 //virtual void setTitle() const;
119 123
120 protected: 124 protected:
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
@@ -37,11 +37,12 @@
37static OConfig globalconfig = OConfig( "global" ); 37static OConfig globalconfig = OConfig( "global" );
38 38
39//FIXME: Is it wise or even necessary to inherit OGlobal from Global? 39//FIXME: Is it wise or even necessary to inherit OGlobal from Global?
40// once we totally skip libqpe it should ideally swallow Global -zecke
40 41
41class OGlobal : public Global 42class OGlobal : public Global
42{ 43{
43 public: 44 public:
44 45 // do we want to put that into OApplication as in KApplication -zecke
45 static OConfig* config(); 46 static OConfig* config();
46}; 47};
47 48
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
@@ -47,6 +47,7 @@
47//FIXME: There's still a whole lot of stuff in here which has to be revised 47//FIXME: There's still a whole lot of stuff in here which has to be revised
48//FIXME: before public usage... lack of time to do it at once - so it will 48//FIXME: before public usage... lack of time to do it at once - so it will
49//FIXME: happen step-by-step. ML. 49//FIXME: happen step-by-step. ML.
50// we should not habe too much configure options!!!!!! -zecke
50 51
51/** 52/**
52 * Access the OPIE global configuration settings. 53 * Access the OPIE global configuration settings.
@@ -99,6 +100,7 @@ class OGlobalSettings
99 * 100 *
100 */ 101 */
101 102
103 // we do not support DND at the momemt -zecke
102 static int dndEventDelay(); 104 static int dndEventDelay();
103 105
104 /** 106 /**
@@ -114,6 +116,7 @@ class OGlobalSettings
114 /** 116 /**
115 * Returns whether tear-off handles are inserted in OPopupMenus. 117 * Returns whether tear-off handles are inserted in OPopupMenus.
116 **/ 118 **/
119 // would clutter the small screen -zecke
117 static bool insertTearOffHandle(); 120 static bool insertTearOffHandle();
118 121
119 /** 122 /**
@@ -251,6 +254,7 @@ class OGlobalSettings
251 /** 254 /**
252 * The path to the desktop directory of the current user. 255 * The path to the desktop directory of the current user.
253 */ 256 */
257 // below handled by Global stuff and QPEApplication
254 static QString desktopPath() { initStatic(); return *s_desktopPath; } 258 static QString desktopPath() { initStatic(); return *s_desktopPath; }
255 259
256 /** 260 /**
@@ -259,8 +263,9 @@ class OGlobalSettings
259 static QString autostartPath() { initStatic(); return *s_autostartPath; } 263 static QString autostartPath() { initStatic(); return *s_autostartPath; }
260 264
261 /** 265 /**
262 * The path to the trash directory of the current user. 266 * The path to the trash directory of the current user.
263 */ 267 */
268 // we do not have that concept -zecke
264 static QString trashPath() { initStatic(); return *s_trashPath; } 269 static QString trashPath() { initStatic(); return *s_trashPath; }
265 270
266 /** 271 /**
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
@@ -21,6 +21,7 @@
21class OManufacturerDB 21class OManufacturerDB
22{ 22{
23 public: 23 public:
24 //FIXME make us consistent -zecke I use self(), sandman inst() you use instance() so we need to chose one!
24 static OManufacturerDB* instance(); 25 static OManufacturerDB* instance();
25 const QString& lookup( const QString& macaddr ) const; 26 const QString& lookup( const QString& macaddr ) const;
26 27
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
@@ -50,6 +50,7 @@ class OWirelessNetworkInterface;
50class OMacAddress 50class OMacAddress
51{ 51{
52 public: 52 public:
53 // QString c'tor? -zecke
53 OMacAddress( unsigned char* ); 54 OMacAddress( unsigned char* );
54 OMacAddress( const unsigned char* ); 55 OMacAddress( const unsigned char* );
55 OMacAddress( struct ifreq& ); 56 OMacAddress( struct ifreq& );
@@ -59,6 +60,7 @@ class OMacAddress
59 QString toString( bool substitute = false ) const; 60 QString toString( bool substitute = false ) const;
60 const unsigned char* native() const; 61 const unsigned char* native() const;
61 62
63 // no c'tor but this one why not make it a c'tor. it could also replace the others or is this the problem?
62 static OMacAddress fromString( const QString& ); 64 static OMacAddress fromString( const QString& );
63 65
64 public: 66 public:
@@ -102,6 +104,7 @@ class OPrivateIOCTL : public QObject
102 int numberSetArgs() const; 104 int numberSetArgs() const;
103 int typeSetArgs() const; 105 int typeSetArgs() const;
104 106
107 // FIXME return int? as ::ioctl does? -zecke
105 void invoke() const; 108 void invoke() const;
106 void setParameter( int, u_int32_t ); 109 void setParameter( int, u_int32_t );
107 110
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
@@ -108,7 +108,7 @@ void ONetwork::synchronize()
108} 108}
109 109
110 110
111ONetworkInterface* ONetwork::interface( QString iface ) const 111ONetworkInterface* ONetwork::interface( const QString& iface ) const
112{ 112{
113 return _interfaces[iface]; 113 return _interfaces[iface];
114} 114}
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
@@ -98,12 +98,14 @@ class ONetwork : public QObject
98 /** 98 /**
99 * @returns true, if the @p interface supports the wireless extension protocol. 99 * @returns true, if the @p interface supports the wireless extension protocol.
100 */ 100 */
101 // FIXME QString? -zecke
101 bool isWirelessInterface( const char* interface ) const; 102 bool isWirelessInterface( const char* interface ) const;
102 /** 103 /**
103 * @returns a pointer to the @ref ONetworkInterface object for the specified @p interface or 0, if not found 104 * @returns a pointer to the @ref ONetworkInterface object for the specified @p interface or 0, if not found
104 * @see ONetworkInterface 105 * @see ONetworkInterface
105 */ 106 */
106 ONetworkInterface* interface( QString interface ) const; 107 // FIXME: const QString& is prefered over QString!!! -zecke
108 ONetworkInterface* interface( const QString& interface ) const;
107 109
108 protected: 110 protected:
109 ONetwork(); 111 ONetwork();
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
@@ -68,7 +68,7 @@ class QSocketNotifier;
68/*====================================================================================== 68/*======================================================================================
69 * OPacket - A frame on the wire 69 * OPacket - A frame on the wire
70 *======================================================================================*/ 70 *======================================================================================*/
71 71// FIXME how many OPackets do we've at a time? QObject seams to be a big for that usage
72class OPacket : public QObject 72class OPacket : public QObject
73{ 73{
74 Q_OBJECT 74 Q_OBJECT
@@ -95,6 +95,7 @@ class OPacket : public QObject
95 * OEthernetPacket - DLT_EN10MB frame 95 * OEthernetPacket - DLT_EN10MB frame
96 *======================================================================================*/ 96 *======================================================================================*/
97 97
98//FIXME same critic as above -zecke
98class OEthernetPacket : public QObject 99class OEthernetPacket : public QObject
99{ 100{
100 Q_OBJECT 101 Q_OBJECT
@@ -115,7 +116,7 @@ class OEthernetPacket : public QObject
115/*====================================================================================== 116/*======================================================================================
116 * OWaveLanPacket - DLT_IEEE802_11 frame 117 * OWaveLanPacket - DLT_IEEE802_11 frame
117 *======================================================================================*/ 118 *======================================================================================*/
118 119//FIXME same
119class OWaveLanPacket : public QObject 120class OWaveLanPacket : public QObject
120{ 121{
121 Q_OBJECT 122 Q_OBJECT
@@ -145,7 +146,7 @@ class OWaveLanPacket : public QObject
145/*====================================================================================== 146/*======================================================================================
146 * OWaveLanManagementPacket - type: management (T_MGMT) 147 * OWaveLanManagementPacket - type: management (T_MGMT)
147 *======================================================================================*/ 148 *======================================================================================*/
148 149//FIXME same as above -zecke
149class OWaveLanManagementPacket : public QObject 150class OWaveLanManagementPacket : public QObject
150{ 151{
151 Q_OBJECT 152 Q_OBJECT
@@ -174,7 +175,7 @@ class OWaveLanManagementPacket : public QObject
174/*====================================================================================== 175/*======================================================================================
175 * OWaveLanManagementSSID 176 * OWaveLanManagementSSID
176 *======================================================================================*/ 177 *======================================================================================*/
177 178//FIXME is QObject necessary? -zecke
178class OWaveLanManagementSSID : public QObject 179class OWaveLanManagementSSID : public QObject
179{ 180{
180 Q_OBJECT 181 Q_OBJECT
@@ -192,7 +193,7 @@ class OWaveLanManagementSSID : public QObject
192/*====================================================================================== 193/*======================================================================================
193 * OWaveLanManagementRates 194 * OWaveLanManagementRates
194 *======================================================================================*/ 195 *======================================================================================*/
195 196// FIXME same as above -zecke
196class OWaveLanManagementRates : public QObject 197class OWaveLanManagementRates : public QObject
197{ 198{
198 Q_OBJECT 199 Q_OBJECT
@@ -209,6 +210,7 @@ class OWaveLanManagementRates : public QObject
209 * OWaveLanManagementCF 210 * OWaveLanManagementCF
210 *======================================================================================*/ 211 *======================================================================================*/
211 212
213//FIXME same....
212class OWaveLanManagementCF : public QObject 214class OWaveLanManagementCF : public QObject
213{ 215{
214 Q_OBJECT 216 Q_OBJECT
@@ -225,6 +227,7 @@ class OWaveLanManagementCF : public QObject
225 * OWaveLanManagementFH 227 * OWaveLanManagementFH
226 *======================================================================================*/ 228 *======================================================================================*/
227 229
230//FIXME same
228class OWaveLanManagementFH : public QObject 231class OWaveLanManagementFH : public QObject
229{ 232{
230 Q_OBJECT 233 Q_OBJECT
@@ -240,7 +243,7 @@ class OWaveLanManagementFH : public QObject
240/*====================================================================================== 243/*======================================================================================
241 * OWaveLanManagementDS 244 * OWaveLanManagementDS
242 *======================================================================================*/ 245 *======================================================================================*/
243 246//FIXME same
244class OWaveLanManagementDS : public QObject 247class OWaveLanManagementDS : public QObject
245{ 248{
246 Q_OBJECT 249 Q_OBJECT
@@ -259,6 +262,7 @@ class OWaveLanManagementDS : public QObject
259 * OWaveLanManagementTim 262 * OWaveLanManagementTim
260 *======================================================================================*/ 263 *======================================================================================*/
261 264
265//FIXME guess what?
262class OWaveLanManagementTim : public QObject 266class OWaveLanManagementTim : public QObject
263{ 267{
264 Q_OBJECT 268 Q_OBJECT
@@ -275,6 +279,7 @@ class OWaveLanManagementTim : public QObject
275 * OWaveLanManagementIBSS 279 * OWaveLanManagementIBSS
276 *======================================================================================*/ 280 *======================================================================================*/
277 281
282//FIXME same as above ( Qobject )
278class OWaveLanManagementIBSS : public QObject 283class OWaveLanManagementIBSS : public QObject
279{ 284{
280 Q_OBJECT 285 Q_OBJECT
@@ -291,6 +296,7 @@ class OWaveLanManagementIBSS : public QObject
291 * OWaveLanManagementChallenge 296 * OWaveLanManagementChallenge
292 *======================================================================================*/ 297 *======================================================================================*/
293 298
299// Qobject do we need that??
294class OWaveLanManagementChallenge : public QObject 300class OWaveLanManagementChallenge : public QObject
295{ 301{
296 Q_OBJECT 302 Q_OBJECT
@@ -306,7 +312,7 @@ class OWaveLanManagementChallenge : public QObject
306/*====================================================================================== 312/*======================================================================================
307 * OWaveLanDataPacket - type: data (T_DATA) 313 * OWaveLanDataPacket - type: data (T_DATA)
308 *======================================================================================*/ 314 *======================================================================================*/
309 315// Qobject?
310class OWaveLanDataPacket : public QObject 316class OWaveLanDataPacket : public QObject
311{ 317{
312 Q_OBJECT 318 Q_OBJECT
@@ -322,7 +328,7 @@ class OWaveLanDataPacket : public QObject
322/*====================================================================================== 328/*======================================================================================
323 * OWaveLanControlPacket - type: control (T_CTRL) 329 * OWaveLanControlPacket - type: control (T_CTRL)
324 *======================================================================================*/ 330 *======================================================================================*/
325 331// Qobject needed?
326class OWaveLanControlPacket : public QObject 332class OWaveLanControlPacket : public QObject
327{ 333{
328 Q_OBJECT 334 Q_OBJECT
@@ -339,6 +345,7 @@ class OWaveLanControlPacket : public QObject
339 * OLLCPacket - IEEE 802.2 Link Level Control 345 * OLLCPacket - IEEE 802.2 Link Level Control
340 *======================================================================================*/ 346 *======================================================================================*/
341 347
348// QObject needed?
342class OLLCPacket : public QObject 349class OLLCPacket : public QObject
343{ 350{
344 Q_OBJECT 351 Q_OBJECT
@@ -348,6 +355,7 @@ class OLLCPacket : public QObject
348 virtual ~OLLCPacket(); 355 virtual ~OLLCPacket();
349 356
350 private: 357 private:
358 //FIXME how to get that header?
351 const struct ieee_802_11_802_2_header* _header; 359 const struct ieee_802_11_802_2_header* _header;
352}; 360};
353 361
@@ -355,6 +363,7 @@ class OLLCPacket : public QObject
355 * OIPPacket 363 * OIPPacket
356 *======================================================================================*/ 364 *======================================================================================*/
357 365
366// Qobject as baseclass?
358class OIPPacket : public QObject 367class OIPPacket : public QObject
359{ 368{
360 Q_OBJECT 369 Q_OBJECT
@@ -381,7 +390,7 @@ class OIPPacket : public QObject
381/*====================================================================================== 390/*======================================================================================
382 * OUDPPacket 391 * OUDPPacket
383 *======================================================================================*/ 392 *======================================================================================*/
384 393// QObject?
385class OUDPPacket : public QObject 394class OUDPPacket : public QObject
386{ 395{
387 Q_OBJECT 396 Q_OBJECT
@@ -401,6 +410,7 @@ class OUDPPacket : public QObject
401 * OTCPPacket 410 * OTCPPacket
402 *======================================================================================*/ 411 *======================================================================================*/
403 412
413// Qobect needed?
404class OTCPPacket : public QObject 414class OTCPPacket : public QObject
405{ 415{
406 Q_OBJECT 416 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
@@ -51,6 +51,7 @@ class QLayoutItem;
51 * 51 *
52 * @author Michael 'Mickey' Lauer <mickey@tm.informatik.uni-frankfurt.de> 52 * @author Michael 'Mickey' Lauer <mickey@tm.informatik.uni-frankfurt.de>
53 */ 53 */
54 // lets fix up Qt instead! Size does matter. -zecke
54 55
55class ODialog : public QDialog 56class ODialog : public QDialog
56{ 57{
@@ -81,8 +82,8 @@ class ODialog : public QDialog
81 static int mMarginSize; 82 static int mMarginSize;
82 static int mSpacingSize; 83 static int mSpacingSize;
83 84
84 //class ODialogPrivate; 85 class ODialogPrivate;
85 //ODialogPrivate *d; 86 ODialogPrivate *d; // d pointer always needed! -zecke
86 87
87}; 88};
88#endif // ODIALOG_H 89#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,5 +1,6 @@
1//FIXME: Revise for Opie - do we really need such fancy stuff on PDA's? 1//FIXME: Revise for Opie - do we really need such fancy stuff on PDA's?
2//FIXME: Maybe not on SL5xxx, but surely on C700 :)) 2//FIXME: Maybe not on SL5xxx, but surely on C700 :))
3//FIXME: I think we don#t need that -zecke
3 4
4/* This file is part of the KDE libraries 5/* This file is part of the KDE libraries
5 Copyright (C) 1998, 1999, 2001, 2002 Daniel M. Duley <mosfet@interaccess.com> 6 Copyright (C) 1998, 1999, 2001, 2002 Daniel M. Duley <mosfet@interaccess.com>
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
@@ -119,7 +119,7 @@ class OListViewItem;
119 */ 119 */
120 virtual OListViewItem* childFactory(); 120 virtual OListViewItem* childFactory();
121 121
122 #ifndef QT_NO_DATASTREAM 122#ifndef QT_NO_DATASTREAM
123 /** 123 /**
124 * serialize this object to a @ref QDataStream 124 * serialize this object to a @ref QDataStream
125 * @param s the stream used to serialize this object. 125 * @param s the stream used to serialize this object.
@@ -131,7 +131,7 @@ class OListViewItem;
131 * @param s the stream used to serialize this object. 131 * @param s the stream used to serialize this object.
132 */ 132 */
133 virtual void serializeFrom( QDataStream& s ); 133 virtual void serializeFrom( QDataStream& s );
134 #endif 134#endif
135 135
136 private: 136 private:
137 QColor m_alternateBackground; 137 QColor m_alternateBackground;
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,3 +1,6 @@
1//FIXME what is ODE? ODE Desktop Environemt? -zecke
2//FIXME do we need titles? space is limited that is only eyecandy? -zecke
3//FIXME keyboard navigation is also not that popular on a PDA might be with a keyboard (tuxphone) -zecke
1/* This file is part of the ODE libraries 4/* This file is part of the ODE libraries
2 Copyright (C) 2000 Daniel M. Duley <mosfet@kde.org> 5 Copyright (C) 2000 Daniel M. Duley <mosfet@kde.org>
3 6
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,5 +1,6 @@
1// QPair minus QT_INLINE_TEMPLATE (instead directly using 'inline' directive) 1// QPair minus QT_INLINE_TEMPLATE (instead directly using 'inline' directive)
2//FIXME: remove and use qpair.h as soon as we're on Qt3 2//FIXME: remove and use qpair.h as soon as we're on Qt3
3// name file qpair -zecke
3 4
4/**************************************************************************** 5/****************************************************************************
5** 6**