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
@@ -2,3 +2,3 @@
     Copyright (C) 2002 Robert Griebl (sandman@handhelds.org)
-            
+
     This library is free software; you can redistribute it and/or
@@ -7,3 +7,3 @@
     version 2 of the License, or (at your option) any later version.
-                             
+
     This library is distributed in the hope that it will be useful,
@@ -12,3 +12,3 @@
     Library General Public License for more details.
-                                          
+
     You should have received a copy of the GNU Library General Public License
@@ -34,5 +34,8 @@ namespace Opie {
 
+/**
+ * The available devices
+ */
 enum OModel {
-        Model_Unknown,
-        
+        Model_Unknown, // = 0
+
         Model_Series_Mask   = 0xff000000,
@@ -57,3 +60,6 @@ enum OModel {
 
-        enum OVendor {
+/**
+ * The vendor of the device
+ */
+enum OVendor {
         Vendor_Unknown,
@@ -62,4 +68,7 @@ enum OVendor {
         Vendor_Sharp
-        };
+};
 
+/**
+ * The System used
+ */
 enum OSystem {
@@ -96,6 +105,18 @@ 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 & );
@@ -106,3 +127,3 @@ protected:
         virtual void initButtons ( );
-        
+
         ODeviceData *d;
@@ -110,4 +131,6 @@ protected:
 public:
+    // sandman do we want to allow destructions? -zecke?
         virtual ~ODevice ( );
 
+
         static ODevice *inst ( );
@@ -116,6 +139,6 @@ public:
 
-        QString modelString ( ) const; 
+        QString modelString ( ) const;
         OModel model ( ) const;
         inline OModel series ( ) const { return (OModel) ( model ( ) & Model_Series_Mask ); }
-        
+
         QString vendorString ( ) const;
@@ -130,3 +153,3 @@ public:
 
-        // system
+// system
 
@@ -138,5 +161,5 @@ public:
         virtual int displayBrightnessResolution ( ) const;
-        
-// input / output
 
+// input / output
+        //FIXME playAlarmSound and al might be better -zecke
         virtual void alarmSound ( );
@@ -161,3 +184,3 @@ public:
         const QValueList<ODeviceButton> &buttons ( );
-        
+
         /**
@@ -177,3 +200,3 @@ public:
          * default pass an empty string as \a qcopMessage.
-                 */ 
+         */
         void remapHeldAction ( int button, const OQCopMessage &qcopMessage );
@@ -185,8 +208,8 @@ public:
 
-        signals:
+signals:
         void buttonMappingChanged ( );
-        
-        private slots:
+
+private slots:
         void systemMessage ( const QCString &, const QByteArray & );
-        
+
 protected: