Jumbo API documentation update

and some API fixed
ColorDialog is now OColorDialog!!! keep the namespace tidy!
ColorPopupMenu is now OColorPopupMenu!!! keep the namespace tidy
ColorDialog TT couldn't break bc we can so make it const QColor&
OTimePicker add some convience methods

more I might have forgot

1 files changed, 43 insertions, 20 deletions

diff --git a/libopie/odevice.h b/libopie/odevice.h
index ff578d8..45a790b 100644
--- a/libopie/odevice.h
+++ b/libopie/odevice.h
@@ -1,15 +1,15 @@
 /*  This file is part of the OPIE libraries
     Copyright (C) 2002 Robert Griebl (sandman@handhelds.org)
-            
+
     This library is free software; you can redistribute it and/or
     modify it under the terms of the GNU Library General Public
     License as published by the Free Software Foundation; either
     version 2 of the License, or (at your option) any later version.
-                             
+
     This library is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Library General Public License for more details.
-                                          
+
     You should have received a copy of the GNU Library General Public License
     along with this library; see the file COPYING.LIB.  If not, write to
@@ -33,7 +33,10 @@ class ODeviceData;
 namespace Opie {
 
+/**
+ * The available devices
+ */
 enum OModel {
-	Model_Unknown,
-	
+        Model_Unknown, // = 0
+
 	Model_Series_Mask   = 0xff000000,
 
@@ -56,11 +59,17 @@ enum OModel {
 };
 
-enum OVendor {	
+/**
+ * The vendor of the device
+ */
+enum OVendor {
 	Vendor_Unknown,
 
 	Vendor_HP,
 	Vendor_Sharp
-};	
+};
 
+/**
+ * The System used
+ */
 enum OSystem {
 	System_Unknown,
@@ -95,8 +104,20 @@ enum OHardKey {
 };
 
+/**
+ * A singleton which gives informations about device specefic option
+ * like the Hardware used, LEDs, the Base Distribution and
+ * hardware key mappings.
+ *
+ *
+ * @short A small class for device specefic options
+ * @see QObject
+ * @author Robert Griebl
+ * @version 1.0
+ */
 class ODevice : public QObject {
 	Q_OBJECT
-	
+
 private:
+        /* disable copy */
 	ODevice ( const ODevice & );
 
@@ -105,18 +126,20 @@ protected:
 	virtual void init ( );
 	virtual void initButtons ( );
-	
+
 	ODeviceData *d;
 
 public:
+    // sandman do we want to allow destructions? -zecke?
 	virtual ~ODevice ( );
 
+
 	static ODevice *inst ( );
 
 // information
 
-	QString modelString ( ) const; 
+	QString modelString ( ) const;
 	OModel model ( ) const;
 	inline OModel series ( ) const { return (OModel) ( model ( ) & Model_Series_Mask ); }
-	
+
 	QString vendorString ( ) const;
 	OVendor vendor ( ) const;
@@ -129,5 +152,5 @@ public:
 	Transformation rotation ( ) const;
 
-// system	
+// system
 
 	virtual bool setSoftSuspend ( bool on );
@@ -137,7 +160,7 @@ public:
 	virtual bool setDisplayBrightness ( int brightness );
 	virtual int displayBrightnessResolution ( ) const;
-	
-// input / output
 
+// input / output
+        //FIXME playAlarmSound and al might be better -zecke
 	virtual void alarmSound ( );
 	virtual void keySound ( );
@@ -160,5 +183,5 @@ public:
 	 */
 	const QValueList<ODeviceButton> &buttons ( );
-	
+
 	/**
 	 * Returns the DeviceButton for the \a keyCode.  If \a keyCode is not found, it
@@ -176,5 +199,5 @@ public:
 	 * Reassigns the held action for \a button.  To return to the factory
 	 * default pass an empty string as \a qcopMessage.
-	 */	 
+	 */
 	void remapHeldAction ( int button, const OQCopMessage &qcopMessage );
 
@@ -184,10 +207,10 @@ public:
 	uint buttonHoldTime ( ) const;
 
-signals:	
+signals:
 	void buttonMappingChanged ( );
-	
-private slots:	
+
+private slots:
 	void systemMessage ( const QCString &, const QByteArray & );
-	
+
 protected:
 	void reloadButtonMapping ( );