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, 25 insertions, 2 deletions

diff --git a/libopie/odevice.h b/libopie/odevice.h
index ff578d8..45a790b 100644
--- a/libopie/odevice.h
+++ b/libopie/odevice.h
@@ -32,8 +32,11 @@ class ODeviceData;
 
 namespace Opie {
 
+/**
+ * The available devices
+ */
 enum OModel {
-	Model_Unknown,
+        Model_Unknown, // = 0
 	
 	Model_Series_Mask   = 0xff000000,
 
@@ -55,6 +58,9 @@ enum OModel {
 	Model_Zaurus_SLC700 = ( Model_Zaurus | 0x000005 ),
 };
 
+/**
+ * The vendor of the device
+ */
 enum OVendor {	
 	Vendor_Unknown,
 
@@ -62,6 +68,9 @@ enum OVendor {
 	Vendor_Sharp
 };	
 
+/**
+ * The System used
+ */
 enum OSystem {
 	System_Unknown,
 
@@ -94,10 +103,22 @@ enum OHardKey {
 	HardKey_Backlight = Qt::Key_F35,
 };
 
+/**
+ * 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 & );
 
 protected:
@@ -108,8 +129,10 @@ protected:
 	ODeviceData *d;
 
 public:
+    // sandman do we want to allow destructions? -zecke?
 	virtual ~ODevice ( );
 
+
 	static ODevice *inst ( );
 
 // information
@@ -138,7 +161,7 @@ public:
 	virtual int displayBrightnessResolution ( ) const;
 	
 // input / output
-
+        //FIXME playAlarmSound and al might be better -zecke
 	virtual void alarmSound ( );
 	virtual void keySound ( );
 	virtual void touchSound ( );