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

31 files changed, 738 insertions, 80 deletions

diff --git a/libopie/colordialog.cpp b/libopie/colordialog.cpp
index 684d6ea..35f15d6 100644
--- a/libopie/colordialog.cpp
+++ b/libopie/colordialog.cpp
@@ -59,2 +59,7 @@ static inline void rgb2hsv( QRgb rgb, int&h, int&s, int&v )
 
+/*
+ * avoid clashes with the original Qt
+ */
+namespace {
+
 class QColorPicker : public QFrame
@@ -609,2 +614,4 @@ void QColorShower::setHsv( int h, int s, int v )
 
+}
+
 class OColorDialogPrivate : public QObject
@@ -615,3 +622,3 @@ public:
     QRgb currentColor() const { return cs->currentColor(); }
-    void setCurrentColor( QRgb rgb );
+    void setCurrentColor( const QRgb& rgb );
 
@@ -639,3 +646,3 @@ void OColorDialogPrivate::newHsv( int h, int s, int v )
 //sets all widgets to display rgb
-void OColorDialogPrivate::setCurrentColor( QRgb rgb )
+void OColorDialogPrivate::setCurrentColor( const QRgb& rgb )
 {
@@ -728,3 +735,3 @@ OColorDialog::OColorDialog(QWidget* parent, const char* name, bool modal) :
 
-QColor OColorDialog::getColor( QColor initial, QWidget *parent,
+QColor OColorDialog::getColor( const QColor& initial, QWidget *parent,
 			       const char *name )
@@ -765,3 +772,3 @@ QColor OColorDialog::getColor( QColor initial, QWidget *parent,
 
-QRgb OColorDialog::getRgba( QRgb initial, bool *ok,
+QRgb OColorDialog::getRgba( const QRgb& initial, bool *ok,
 			    QWidget *parent, const char* name )
@@ -821,3 +828,3 @@ OColorDialog::~OColorDialog()
 
-void OColorDialog::setColor( QColor c )
+void OColorDialog::setColor( const QColor& c )
 {
diff --git a/libopie/colordialog.h b/libopie/colordialog.h
index 926f8f2..e9bb7ed 100644
--- a/libopie/colordialog.h
+++ b/libopie/colordialog.h
@@ -63,4 +63,4 @@ class Q_EXPORT OColorDialog : public QDialog
 public:
-    static QColor getColor( QColor, QWidget *parent=0, const char* name=0 ); // ### 3.0: make const QColor&
-    static QRgb getRgba( QRgb, bool* ok = 0,
+    static QColor getColor( const QColor&, QWidget *parent=0, const char* name=0 ); 
+    static QRgb getRgba( const QRgb&, bool* ok = 0,
 			 QWidget *parent=0, const char* name=0 );
@@ -71,3 +71,3 @@ private:
     OColorDialog( QWidget* parent=0, const char* name=0, bool modal=FALSE );
-    void setColor( QColor ); // ### 3.0: make const QColor&
+    void setColor( const QColor& );
     QColor color() const;
diff --git a/libopie/colorpopupmenu.cpp b/libopie/colorpopupmenu.cpp
index 510a2ad..dac10e9 100644
--- a/libopie/colorpopupmenu.cpp
+++ b/libopie/colorpopupmenu.cpp
@@ -39,3 +39,3 @@
 
-ColorPanelButton::ColorPanelButton( const QColor& color, QWidget* parent, const char* name )
+OColorPanelButton::OColorPanelButton( const QColor& color, QWidget* parent, const char* name )
     : QFrame( parent, name )
@@ -48,3 +48,3 @@ ColorPanelButton::ColorPanelButton( const QColor& color, QWidget* parent, const
 
-ColorPanelButton::~ColorPanelButton()
+OColorPanelButton::~OColorPanelButton()
 {
@@ -52,3 +52,3 @@ ColorPanelButton::~ColorPanelButton()
 
-void ColorPanelButton::setActive( bool active )
+void OColorPanelButton::setActive( bool active )
 {
@@ -63,6 +63,4 @@ void ColorPanelButton::setActive( bool active )
 
-void ColorPanelButton::enterEvent( QEvent* e )
+void OColorPanelButton::enterEvent( QEvent*  )
 {
-    Q_UNUSED( e )
-
     if ( !m_active ) {
@@ -72,6 +70,4 @@ void ColorPanelButton::enterEvent( QEvent* e )
 
-void ColorPanelButton::leaveEvent( QEvent* e )
+void OColorPanelButton::leaveEvent( QEvent*  )
 {
-    Q_UNUSED( e )
-
     if ( !m_active ) {
@@ -81,3 +77,3 @@ void ColorPanelButton::leaveEvent( QEvent* e )
 
-void ColorPanelButton::paintEvent( QPaintEvent* e )
+void OColorPanelButton::paintEvent( QPaintEvent* e )
 {
@@ -93,6 +89,4 @@ void ColorPanelButton::paintEvent( QPaintEvent* e )
 
-void ColorPanelButton::mouseReleaseEvent( QMouseEvent* e )
+void OColorPanelButton::mouseReleaseEvent( QMouseEvent*   )
 {
-    Q_UNUSED( e )
-
     emit selected( m_color );
@@ -100,3 +94,3 @@ void ColorPanelButton::mouseReleaseEvent( QMouseEvent* e )
 
-ColorPopupMenu::ColorPopupMenu( const QColor& color, QWidget* parent, const char* name )
+OColorPopupMenu::OColorPopupMenu( const QColor& color, QWidget* parent, const char* name )
     : QPopupMenu( parent, name )
@@ -151,3 +145,3 @@ ColorPopupMenu::ColorPopupMenu( const QColor& color, QWidget* parent, const char
 
-ColorPopupMenu::~ColorPopupMenu()
+OColorPopupMenu::~OColorPopupMenu()
 {
@@ -155,5 +149,5 @@ ColorPopupMenu::~ColorPopupMenu()
 
-void ColorPopupMenu::addColor( const QColor& color, int row, int col )
+void OColorPopupMenu::addColor( const QColor& color, int row, int col )
 {
-    ColorPanelButton* panelButton = new ColorPanelButton( color, colorPanel );
+    OColorPanelButton* panelButton = new OColorPanelButton( color, colorPanel );
     connect( panelButton, SIGNAL( selected( const QColor& ) ), this, SLOT( buttonSelected( const QColor& ) ) );
@@ -162,3 +156,3 @@ void ColorPopupMenu::addColor( const QColor& color, int row, int col )
 
-void ColorPopupMenu::buttonSelected( const QColor& color )
+void OColorPopupMenu::buttonSelected( const QColor& color )
 {
@@ -169,3 +163,3 @@ void ColorPopupMenu::buttonSelected( const QColor& color )
 
-void ColorPopupMenu::moreColorClicked()
+void OColorPopupMenu::moreColorClicked()
 {
diff --git a/libopie/colorpopupmenu.h b/libopie/colorpopupmenu.h
index b0453b2..184b132 100644
--- a/libopie/colorpopupmenu.h
+++ b/libopie/colorpopupmenu.h
@@ -42,12 +42,12 @@ class QGridLayout;
 /**
- * @class ColorPanelButton
- * @brief The ColorPanelButton class provides a button for color selection.
+ * @class OColorPanelButton
+ * @brief The OColorPanelButton class provides a button for color selection.
  *
- * @see ColorPopupMenu
+ * @see OColorPopupMenu
  *
- * The ColorPanelButton class provides a button for color selection.  The button
+ * The OColorPanelButton class provides a button for color selection.  The button
  * is drawn with the desired color and no border.  This class is used internally
- * by the ColorPopupMenu class to displaying colors in its menu.
+ * by the OColorPopupMenu class to displaying colors in its menu.
  */
-class ColorPanelButton : public QFrame
+class OColorPanelButton : public QFrame
 {
@@ -58,3 +58,3 @@ public:
 /**
- * @fn ColorPanelButton( const QColor& color, QWidget* parent = 0, const char* name = 0 )
+ * @fn OColorPanelButton( const QColor& color, QWidget* parent = 0, const char* name = 0 )
  * @brief Object constructor.
@@ -67,3 +67,3 @@ public:
  */
-    ColorPanelButton(const QColor& color, QWidget* parent = 0, const char* name = 0);
+    OColorPanelButton(const QColor& color, QWidget* parent = 0, const char* name = 0);
 
@@ -73,3 +73,3 @@ public:
  */
-    ~ColorPanelButton();
+    ~OColorPanelButton();
 
@@ -152,7 +152,7 @@ private:
 /**
- * @class ColorPopupMenu
- * @brief The ColorPopupMenu class provides a small color selection
+ * @class OColorPopupMenu
+ * @brief The OColorPopupMenu class provides a small color selection
  *        popup menu.
  *
- * ColorPopupMenu is a derivation of TrollTech's QPopupMenu and provides
+ * OColorPopupMenu is a derivation of TrollTech's QPopupMenu and provides
  * a small color selection popup menu which can be attached to another control
@@ -164,3 +164,3 @@ private:
  */
-class ColorPopupMenu : public QPopupMenu
+class OColorPopupMenu : public QPopupMenu
 {
@@ -171,3 +171,3 @@ public:
 /**
- * @fn ColorPopupMenu( const QColor& color, QWidget* parent = 0, const char* name = 0 )
+ * @fn OColorPopupMenu( const QColor& color, QWidget* parent = 0, const char* name = 0 )
  * @brief Object constructor.
@@ -178,11 +178,11 @@ public:
  *
- * Constructs a new ColorPopupMenu control with parent, name and initial color selected.
+ * Constructs a new OColorPopupMenu control with parent, name and initial color selected.
  */
-    ColorPopupMenu( const QColor& color, QWidget* parent = 0, const char* name = 0 );
+    OColorPopupMenu( const QColor& color, QWidget* parent = 0, const char* name = 0 );
 
 /**
- * @fn ~ColorPopupMenu()
+ * @fn ~OColorPopupMenu()
  * @brief Object destructor.
  */
-    ~ColorPopupMenu();
+    ~OColorPopupMenu();
 
diff --git a/libopie/ocheckitem.cpp b/libopie/ocheckitem.cpp
index d6ddc79..082d7a2 100644
--- a/libopie/ocheckitem.cpp
+++ b/libopie/ocheckitem.cpp
@@ -16,2 +16,9 @@
 
+/**
+ * Constructs an CheckItem with a QTable as parent
+ * and a sort key for.
+ * The sort key will be used by QTable to sort the table later
+ * @param t The parent QTable where the check item belongs
+ * @param key A sort key
+ */
 OCheckItem::OCheckItem( QTable *t, const QString &key )
@@ -21,2 +28,7 @@ OCheckItem::OCheckItem( QTable *t, const QString &key )
 
+/**
+ * reimplemted for internal reasons
+ * @return Returns the sort key of the Item
+ * @see QTableItem
+ */
 QString OCheckItem::key() const
@@ -26,2 +38,8 @@ QString OCheckItem::key() const
 
+/**
+ * This method can check or uncheck the item. It will
+ * call QTable to update the cell.
+ *
+ * @param b Whether to check or uncheck the item
+ */
 void OCheckItem::setChecked( bool b )
@@ -32,2 +50,6 @@ void OCheckItem::setChecked( bool b )
 
+/**
+ * This will toggle the item. If it is checked it'll get
+ * unchecked by this method or vice versa.
+ */
 void OCheckItem::toggle()
@@ -37,2 +59,7 @@ void OCheckItem::toggle()
 
+/**
+ * This will return the state of the item.
+ *
+ * @return Returns true if the item is checked
+ */
 bool OCheckItem::isChecked() const
@@ -42,2 +69,6 @@ bool OCheckItem::isChecked() const
 
+/**
+ * @internal
+ * This paints the item
+ */
 void OCheckItem::paint( QPainter *p, const QColorGroup &cg, const QRect &cr,
diff --git a/libopie/ocheckitem.h b/libopie/ocheckitem.h
index 7885032..2387134 100644
--- a/libopie/ocheckitem.h
+++ b/libopie/ocheckitem.h
@@ -16,2 +16,14 @@
 
+/**
+ * This class represents a checkable QTableItem. This can
+ * be added to any QTable.
+ *
+ *
+ * @see QTable
+ * @see QTableItem
+ * @short An checkable QTableItem
+ * @version 1.0
+ * @author Stefan Eilers ( eilers@handhelds.org )
+ */
+
 class OCheckItem : public QTableItem
diff --git a/libopie/oclickablelabel.cpp b/libopie/oclickablelabel.cpp
index 5768529..bc7037b 100644
--- a/libopie/oclickablelabel.cpp
+++ b/libopie/oclickablelabel.cpp
@@ -3,2 +3,9 @@
 
+/**
+ * This constructs the clickable ButtonLabel
+ *
+ * @param parent The parent of this label
+ * @param name A name of this label @see QObject
+ * @param fl The windowing flags
+ */
 OClickableLabel::OClickableLabel(QWidget* parent, 
@@ -15,2 +22,7 @@ OClickableLabel::OClickableLabel(QWidget* parent,
 
+/**
+ * This method makes the label behave as a toggle button
+ *
+ * @param t Whether or not to behave like a toggle button
+ */
 void OClickableLabel::setToggleButton(bool t) {
@@ -19,2 +31,5 @@ void OClickableLabel::setToggleButton(bool t) {
 
+/**
+ * @internal
+ */
 void OClickableLabel::mousePressEvent( QMouseEvent * /*e*/ ) {
@@ -27,2 +42,5 @@ void OClickableLabel::mousePressEvent( QMouseEvent * /*e*/ ) {
 
+/**
+ * @internal
+ */
 void OClickableLabel::mouseReleaseEvent( QMouseEvent *e ) {
@@ -44,2 +62,5 @@ void OClickableLabel::mouseReleaseEvent( QMouseEvent *e ) {
 
+/**
+ * @internal
+ */
 void OClickableLabel::mouseMoveEvent( QMouseEvent *e ) {
@@ -60,2 +81,7 @@ void OClickableLabel::mouseMoveEvent( QMouseEvent *e ) {
 
+/**
+ * this toggles the label and inverts the color of
+ * the label
+ * @param on
+ */
 void OClickableLabel::showState(bool on) {
@@ -84,2 +110,5 @@ void OClickableLabel::setInverted(bool on) {
 
+/**
+ * @param on if the Label is down or up
+ */
 void OClickableLabel::setOn(bool on) {
diff --git a/libopie/oclickablelabel.h b/libopie/oclickablelabel.h
index f65c440..4b6dcbc 100644
--- a/libopie/oclickablelabel.h
+++ b/libopie/oclickablelabel.h
@@ -5,2 +5,22 @@
 
+/**
+ * This class is a special QLabel which can behave
+ * as a QPushButton or QToggleButton.
+ * The reason to use a clickable is if you want to save space
+ * or you want to skip the border of a normal button
+ *
+ * <pre>
+ *  QLabel* lbl = new OClickableLabel( parent, "PushLabel" );
+ *  lbl->setPixmap( "config" );
+ *  QWhatsThis::add( lbl, tr("Click here to do something") );
+ * </pre>
+ *
+ * @short A Label behaving as button
+ * @author Hakan Ardo, Maximillian Reiß ( harlekin@handhelds.org )
+ * @see QLabel
+ * @see QPushButton
+ * @see QToggleButton
+ * @version 1.0
+ */
+
 class OClickableLabel: public QLabel 
@@ -12,2 +32,3 @@ public:
     void setToggleButton(bool t);
+
  protected:
@@ -16,2 +37,3 @@ public:
     void mouseMoveEvent( QMouseEvent *e );
+
  public slots:
@@ -22,6 +44,7 @@ public:
  private:
-    bool isToggle;
-    bool isDown;
+    bool isToggle : 1;
+    bool isDown : 1;
+    bool textInverted : 1;
+
     void showState(bool on);
-    bool textInverted;
     void setInverted(bool on);
diff --git a/libopie/ocolorbutton.cpp b/libopie/ocolorbutton.cpp
index ddb6c4f..113a77a 100644
--- a/libopie/ocolorbutton.cpp
+++ b/libopie/ocolorbutton.cpp
@@ -36,4 +36,3 @@
 
-class OColorButtonPrivate {
-public:
+struct OColorButtonPrivate {
 	QPopupMenu *m_menu;
@@ -42,2 +41,11 @@ public:
 
+
+/**
+ * This concstructs a Color Button with @param color as the start color
+ * It'll use a OColorPopupMenu internally
+ *
+ * @param parent The parent of the Color Button
+ * @param color The color from where to start on
+ * @param name @see QObject
+ */
 OColorButton::OColorButton ( QWidget *parent, const QColor &color, const char *name )
@@ -47,3 +55,3 @@ OColorButton::OColorButton ( QWidget *parent, const QColor &color, const char *n
 
-	d-> m_menu = new ColorPopupMenu ( color, 0, 0 );
+	d-> m_menu = new OColorPopupMenu ( color, 0, 0 );
 	setPopup ( d-> m_menu );
@@ -59,2 +67,5 @@ OColorButton::OColorButton ( QWidget *parent, const QColor &color, const char *n
 
+/**
+ * This destructs the object
+ */
 OColorButton::~OColorButton ( )
@@ -64,2 +75,5 @@ OColorButton::~OColorButton ( )
 
+/**
+ * @return Returns the current color of the button
+ */
 QColor OColorButton::color ( ) const
@@ -69,2 +83,6 @@ QColor OColorButton::color ( ) const
 
+/**
+ * This method sets the color of the button
+ * @param c The color to be set.
+ */
 void OColorButton::setColor ( const QColor &c )
@@ -74,2 +92,5 @@ void OColorButton::setColor ( const QColor &c )
 
+/**
+ * @internal
+ */
 void OColorButton::updateColor ( const QColor &c )
diff --git a/libopie/ocolorbutton.h b/libopie/ocolorbutton.h
index fe40fae..338e654 100644
--- a/libopie/ocolorbutton.h
+++ b/libopie/ocolorbutton.h
@@ -36,2 +36,9 @@ class QColor;
 
+/**
+ *
+ * @short A Button which will show a OColorPopupMenu
+ * @author Robert Griebl ( sandman@handhelds.org )
+ * @version 1.0
+ * @see QPushButton
+ */
 class OColorButton : public QPushButton {
diff --git a/libopie/odevice.cpp b/libopie/odevice.cpp
index 9b2a954..8f954b1 100644
--- a/libopie/odevice.cpp
+++ b/libopie/odevice.cpp
@@ -55,3 +55,3 @@ class ODeviceData {
 public:
-	bool m_qwsserver;
+	bool m_qwsserver : 1;
 
@@ -272,2 +272,5 @@ void ODevice::init ( )
 
+/**
+ * This method initialises the  button mapping
+ */
 void ODevice::initButtons ( )
@@ -315,3 +318,13 @@ bool ODevice::setSoftSuspend ( bool /*soft*/ )
 
-
+/**
+ * This method will try to suspend the device
+ * It only works if the user is the QWS Server and the apm application
+ * is installed.
+ * It tries to suspend and then waits some time cause some distributions
+ * do have asynchronus apm implementations.
+ * This method will either fail and return false or it'll suspend the
+ * device and return once the device got woken up
+ *
+ * @return if the device got suspended
+ */
 bool ODevice::suspend ( )
@@ -356,3 +369,5 @@ bool ODevice::suspend ( )
 
-
+/**
+ * This sets the display on or off
+ */
 bool ODevice::setDisplayStatus ( bool on )
@@ -372,4 +387,9 @@ bool ODevice::setDisplayStatus ( bool on )
 
-bool ODevice::setDisplayBrightness ( int )
+/**
+ * This sets the display brightness
+ * @return success or failure
+ */
+bool ODevice::setDisplayBrightness ( int p)
 {
+        Q_UNUSED( p )
 	return false;
@@ -382,2 +402,6 @@ int ODevice::displayBrightnessResolution ( ) const
 
+/**
+ * This returns the vendor as string
+ * @return Vendor as QString
+ */
 QString ODevice::vendorString ( ) const
@@ -387,2 +411,6 @@ QString ODevice::vendorString ( ) const
 
+/**
+ * This returns the vendor as one of the values of OVendor
+ * @return OVendor
+ */
 OVendor ODevice::vendor ( ) const
@@ -392,2 +420,6 @@ OVendor ODevice::vendor ( ) const
 
+/**
+ * This returns the model as a string
+ * @return A string representing the model
+ */
 QString ODevice::modelString ( ) const
@@ -397,2 +429,5 @@ QString ODevice::modelString ( ) const
 
+/**
+ * This does return the OModel used
+ */
 OModel ODevice::model ( ) const
@@ -402,2 +437,5 @@ OModel ODevice::model ( ) const
 
+/**
+ * This does return the systen name
+ */
 QString ODevice::systemString ( ) const
@@ -407,2 +445,5 @@ QString ODevice::systemString ( ) const
 
+/**
+ * Return System as OSystem value
+ */
 OSystem ODevice::system ( ) const
@@ -412,2 +453,5 @@ OSystem ODevice::system ( ) const
 
+/**
+ * @return the version string of the base system
+ */
 QString ODevice::systemVersionString ( ) const
@@ -417,2 +461,5 @@ QString ODevice::systemVersionString ( ) const
 
+/**
+ *  @return the current Transformation
+ */
 Transformation ODevice::rotation ( ) const
@@ -422,2 +469,5 @@ Transformation ODevice::rotation ( ) const
 
+/**
+ * This plays an alarmSound
+ */
 void ODevice::alarmSound ( )
@@ -432,2 +482,5 @@ void ODevice::alarmSound ( )
 
+/**
+ * This plays a key sound
+ */
 void ODevice::keySound ( )
@@ -442,2 +495,5 @@ void ODevice::keySound ( )
 
+/**
+ * This plays a touch sound
+ */
 void ODevice::touchSound ( )
@@ -453,3 +509,7 @@ void ODevice::touchSound ( )
 
-
+/**
+ * This method will return a list of leds
+ * available on this device
+ * @return a list of LEDs.
+ */
 QValueList <OLed> ODevice::ledList ( ) const
@@ -459,2 +519,5 @@ QValueList <OLed> ODevice::ledList ( ) const
 
+/**
+ * This does return the state of the LEDs
+ */
 QValueList <OLedState> ODevice::ledStateList ( OLed /*which*/ ) const
@@ -464,2 +527,5 @@ QValueList <OLedState> ODevice::ledStateList ( OLed /*which*/ ) const
 
+/**
+ * @return the state for a given OLed
+ */
 OLedState ODevice::ledState ( OLed /*which*/ ) const
@@ -469,4 +535,12 @@ OLedState ODevice::ledState ( OLed /*which*/ ) const
 
-bool ODevice::setLedState ( OLed /*which*/, OLedState /*st*/ )
+/**
+ * Set the state for a LED
+ * @param which Which OLed to use
+ * @param st The state to set
+ * @return success or failure
+ */
+bool ODevice::setLedState ( OLed which, OLedState st )
 {
+        Q_UNUSED( which )
+        Q_UNUSED( st    )
 	return false;
@@ -474,2 +548,5 @@ bool ODevice::setLedState ( OLed /*which*/, OLedState /*st*/ )
 
+/**
+ * @return if the device has a light sensor
+ */
 bool ODevice::hasLightSensor ( ) const
@@ -479,2 +556,5 @@ bool ODevice::hasLightSensor ( ) const
 
+/**
+ * @return a value from the light senso
+ */
 int ODevice::readLightSensor ( )
@@ -484,2 +564,5 @@ int ODevice::readLightSensor ( )
 
+/**
+ * @return the light sensor resolution whatever that is ;)
+ */
 int ODevice::lightSensorResolution ( ) const
@@ -489,2 +572,5 @@ int ODevice::lightSensorResolution ( ) const
 
+/**
+ * @return a list of hardware buttons
+ */
 const QValueList <ODeviceButton> &ODevice::buttons ( )
@@ -496,2 +582,5 @@ const QValueList <ODeviceButton> &ODevice::buttons ( )
 
+/**
+ * @return The amount of time that would count as a hold
+ */
 uint ODevice::buttonHoldTime ( ) const
@@ -501,2 +590,9 @@ uint ODevice::buttonHoldTime ( ) const
 
+/**
+ * This method return a ODeviceButton for a key code
+ * or 0 if no special hardware button is available for the device
+ *
+ * @return The devicebutton or 0l
+ * @see ODeviceButton
+ */
 const ODeviceButton *ODevice::buttonForKeycode ( ushort code )
diff --git a/libopie/odevice.h b/libopie/odevice.h
index ff578d8..45a790b 100644
--- a/libopie/odevice.h
+++ b/libopie/odevice.h
@@ -34,4 +34,7 @@ namespace Opie {
 
+/**
+ * The available devices
+ */
 enum OModel {
-	Model_Unknown,
+        Model_Unknown, // = 0
 	
@@ -57,2 +60,5 @@ enum OModel {
 
+/**
+ * The vendor of the device
+ */
 enum OVendor {	
@@ -64,2 +70,5 @@ enum OVendor {
 
+/**
+ * The System used
+ */
 enum OSystem {
@@ -96,2 +105,13 @@ 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 {
@@ -100,2 +120,3 @@ class ODevice : public QObject {
 private:
+        /* disable copy */
 	ODevice ( const ODevice & );
@@ -110,4 +131,6 @@ protected:
 public:
+    // sandman do we want to allow destructions? -zecke?
 	virtual ~ODevice ( );
 
+
 	static ODevice *inst ( );
@@ -140,3 +163,3 @@ public:
 // input / output
-
+        //FIXME playAlarmSound and al might be better -zecke
 	virtual void alarmSound ( );
diff --git a/libopie/odevicebutton.h b/libopie/odevicebutton.h
index 5281ab2..cf91bbd 100644
--- a/libopie/odevicebutton.h
+++ b/libopie/odevicebutton.h
@@ -60,2 +60,6 @@ private:
  * may be used to describe this button to the user in help documentation.
+ *
+ * @version 1.0
+ * @author Trolltech
+ * @short A representation of buttons
  */
diff --git a/libopie/ofiledialog.cc b/libopie/ofiledialog.cc
index 4783004..9e725c2 100644
--- a/libopie/ofiledialog.cc
+++ b/libopie/ofiledialog.cc
@@ -35,2 +35,13 @@
 
+/**
+ * This constructs a modal dialog
+ *
+ * @param caption The caption of the dialog
+ * @param wid The parent widget
+ * @param mode The mode of the OFileSelector @see OFileSelector
+ * @param selector The selector of the OFileSelector
+ * @param dirName the dir or resource to start from
+ * @param fileName  a proposed or existing filename
+ * @param mimetypes The mimeTypes
+ */
 OFileDialog::OFileDialog(const QString &caption,
@@ -62,2 +73,6 @@ OFileDialog::OFileDialog(const QString &caption,
 }
+/**
+ * @returns the mimetype of the selected
+ * currently it return QString::null
+ */
 QString OFileDialog::mimetype()const
@@ -66,2 +81,6 @@ QString OFileDialog::mimetype()const
 }
+
+/**
+ * @return the fileName
+ */
 QString OFileDialog::fileName()const
@@ -70,2 +89,6 @@ QString OFileDialog::fileName()const
 }
+
+/**
+ * return a DocLnk to the current file
+ */
 DocLnk OFileDialog::selectedDocument()const
@@ -74,2 +97,14 @@ DocLnk OFileDialog::selectedDocument()const
 }
+
+/**
+ * This opens up a filedialog in Open mode
+ *
+ * @param selector the Selector Mode
+ * @param startDir Where to start from
+ * @param file A proposed filename
+ * @param mimes A list of MimeTypes
+ * @param wid the parent
+ * @param caption of the dialog if QString::null tr("Open") will be used
+ * @return the fileName or QString::null
+ */
 QString OFileDialog::getOpenFileName(int selector,
@@ -90,2 +125,7 @@ QString OFileDialog::getOpenFileName(int selector,
 }
+
+/**
+ * This opens up a file dialog in save mode
+ * @see getOpenFileName
+ */
 QString OFileDialog::getSaveFileName(int selector,
diff --git a/libopie/ofiledialog.h b/libopie/ofiledialog.h
index e14253c..309086b 100644
--- a/libopie/ofiledialog.h
+++ b/libopie/ofiledialog.h
@@ -36,2 +36,25 @@
 
+/**
+ * This class places a OFileSelector inside a QDialog.
+ * It provides static method for letting a user chose
+ * a file for either opening or saving.
+ * Most of the time  the c'tor will not be used instead using
+ * the static member functions is prefered.
+ *
+ * <pre>
+ * QMap<QString, QStringList> mimeTypes;
+ * QStringList types;
+ * types << "text/* ";
+ * mimeTypes.insert( tr("Text"), types );
+ * mimeTypes.insert( tr("All"), " * / * " ); // remove the spaces in the 2nd comment
+ * QString fileName= OFileDialog::getOpenFileName( OFileSelector::EXTENDED_ALL,
+ *                                                 "foo","bar", mimeTypes);
+ * </pre>
+ *
+ * @short A small QDialog swalloing a FileSelector
+ * @see QDialog
+ * @see OFileSelector
+ * @version 0.1-unfinished
+ * @author Holger Freyther ( zecke@handhelds.org )
+ */
 class OFileDialog : public QDialog {
diff --git a/libopie/ofileselector.h b/libopie/ofileselector.h
index 17c494e..06ac806 100644
--- a/libopie/ofileselector.h
+++ b/libopie/ofileselector.h
@@ -123,2 +123,4 @@ class OFileSelector : public QWidget {
   // currently only for the FILESELECTOR Mode
+  /**
+   */
   void setNewVisible( bool /*b*/ );
diff --git a/libopie/ofontmenu.cc b/libopie/ofontmenu.cc
index 52ff3ee..d16c5e5 100644
--- a/libopie/ofontmenu.cc
+++ b/libopie/ofontmenu.cc
@@ -6,3 +6,9 @@
 
-
+/**
+ * Constructs the FontMenu.
+ *
+ * @param parent The parent widget
+ * @param name A name for this widget
+ * @param list The list of widgets to be controlled
+ */
 OFontMenu::OFontMenu(QWidget *parent, const char *name, const QList<QWidget> &list )
@@ -22,2 +28,9 @@ OFontMenu::OFontMenu(QWidget *parent, const char *name, const QList<QWidget> &li
 }
+
+/**
+ * This method saves the font size
+ * into a Config object
+ * OFontMenu will be used as group and size as key
+ * @param cfg The Config object to be used
+ */
 void OFontMenu::save(Config *cfg )
@@ -27,2 +40,8 @@ void OFontMenu::save(Config *cfg )
 }
+
+/**
+ * This method restores the font size from a Config object
+ * it'll apply the sizes to the widgets and will also set the
+ * menu appropriate
+ */
 void OFontMenu::restore(Config *cfg )
@@ -49,2 +68,7 @@ void OFontMenu::restore(Config *cfg )
 }
+
+/**
+ * set the list of widgets
+ * @param list the widget list
+ */
 void OFontMenu::setWidgets(const QList<QWidget> &list )
@@ -53,2 +77,7 @@ void OFontMenu::setWidgets(const QList<QWidget> &list )
 }
+
+/**
+ * add a widget to the list
+ * @param wid The widget to be added
+ */
 void OFontMenu::addWidget( QWidget *wid )
@@ -57,2 +86,7 @@ void OFontMenu::addWidget( QWidget *wid )
 }
+
+/**
+ * removes the widget from the list of controlled objects
+ * @param wid the to be removed widget
+ */
 void OFontMenu::removeWidget( QWidget *wid )
@@ -61,2 +95,6 @@ void OFontMenu::removeWidget( QWidget *wid )
 }
+
+/**
+ * The list of controlled widgets
+ */
 const QList<QWidget> &OFontMenu::widgets()const
@@ -65,2 +103,8 @@ const QList<QWidget> &OFontMenu::widgets()const
 }
+
+/**
+ * Forces a size on a widget
+ * @param wid The widget
+ * @param size The font size forced onto the widget
+ */
 void OFontMenu::forceSize(QWidget *wid, int size )
diff --git a/libopie/ofontmenu.h b/libopie/ofontmenu.h
index 5fd515f..6e143ca 100644
--- a/libopie/ofontmenu.h
+++ b/libopie/ofontmenu.h
@@ -39,3 +39,5 @@
 
-
+/*
+ * @internal
+ */
 namespace {
@@ -48,4 +50,26 @@ namespace {
 
-// if i would be on kde this would be a KActionMenu...
+// forward declarations
 class Config;
+
+/**
+ * This class is a specialised QPopupMenu. It'll display three different
+ * font sizes. Small, Normal and large by adding widgets to the Menu
+ * you can control the font size of these widgets
+ * by using the save and restore method you can also apply font sizes
+ * over two different runtimes
+ *
+ * <pre>
+ * QTable* tbl = new QTable();
+ * QList<QWidget> wid;
+ * wid.append( tbl );
+ * OFontMenu* menu = new OFontMenu(this, "Popup Menu", wid );
+ * Config cfg("mycfg");
+ * menu->restore( cfg );
+ * </pre>
+ *
+ * @author Holger Freyther ( zecke@handhelds.org )
+ * @version 0.1
+ * @short PopupMenu which can control the size of Widgets
+ * @see QPopupMenu
+ */
 class OFontMenu : public QPopupMenu {
@@ -63,3 +87,8 @@ class OFontMenu : public QPopupMenu {
  signals:
+    /**
+     * this signal gets emitted when the font size gets changed
+     * @param size The new size of font
+     */
   void fontChanged(int size );
+
  private:
@@ -70,2 +99,3 @@ class OFontMenu : public QPopupMenu {
   OFontMenuPrivate *d;
+
  private slots:
diff --git a/libopie/ofontselector.cpp b/libopie/ofontselector.cpp
index b905474..c8471cc 100644
--- a/libopie/ofontselector.cpp
+++ b/libopie/ofontselector.cpp
@@ -46,3 +46,3 @@ public:
 
-	bool            m_pointbug;
+	bool            m_pointbug : 1;
 
@@ -51,2 +51,3 @@ public:
 
+namespace {
 
@@ -96,3 +97,4 @@ static int findItemCB ( QComboBox *box, const QString &str )
 
-
+}
+/* static same as anon. namespace */
 static int qt_version ( )
@@ -104,3 +106,9 @@ static int qt_version ( )
 
-
+/**
+ * Constructs the Selector object
+ * @param withpreview If a font preview should be given
+ * @param parent The parent of the Font Selector
+ * @param name The name of the object
+ * @param fl WidgetFlags
+ */
 OFontSelector::OFontSelector ( bool withpreview, QWidget *parent, const char *name, WFlags fl ) : QWidget ( parent, name, fl )
@@ -154,2 +162,7 @@ OFontSelector::~OFontSelector ( )
 
+/**
+ * This methods tries to set the font
+ * @param f The wishes font
+ * @return success or failure
+ */
 bool OFontSelector::setSelectedFont ( const QFont &f )
@@ -159,3 +172,11 @@ bool OFontSelector::setSelectedFont ( const QFont &f )
 
-bool OFontSelector::setSelectedFont ( const QString &familyStr, const QString &styleStr, int sizeVal, const QString & /*charset*/ )
+
+/**
+ * This is an overloaded method @see setSelectedFont
+ * @param familyStr The family of the font
+ * @param styleStr The style of the font
+ * @param sizeVal The size of font
+ * @param charset The charset to be used. Will be deprecated by QT3
+ */
+bool OFontSelector::setSelectedFont ( const QString &familyStr, const QString &styleStr, int sizeVal, const QString & charset )
 {
@@ -190,2 +211,10 @@ bool OFontSelector::setSelectedFont ( const QString &familyStr, const QString &s
 
+/**
+ * This method returns the name, style and size of the currently selected
+ * font or false if no font is selected
+ * @param family The font family will be written there
+ * @param style The style will be written there
+ * @param size The size will be written there
+ * @return success or failure
+ */
 bool OFontSelector::selectedFont ( QString &family, QString &style, int &size )
@@ -197,2 +226,7 @@ bool OFontSelector::selectedFont ( QString &family, QString &style, int &size )
 
+/**
+ * This method does return the font family or QString::null if there is
+ * no font item selected
+ * @return the font family
+ */
 QString OFontSelector::fontFamily ( ) const
@@ -204,2 +238,6 @@ QString OFontSelector::fontFamily ( ) const
 
+/**
+ * This method will return the style of the font or QString::null
+ * @return the style of the font
+ */
 QString OFontSelector::fontStyle ( ) const
@@ -212,2 +250,5 @@ QString OFontSelector::fontStyle ( ) const
 
+/**
+ * This method will return the font size or 10 if no font size is available
+ */
 int OFontSelector::fontSize ( ) const
@@ -220,2 +261,5 @@ int OFontSelector::fontSize ( ) const
 
+/**
+ * returns the charset of the font or QString::null
+ */
 QString OFontSelector::fontCharSet ( ) const
@@ -227,2 +271,6 @@ QString OFontSelector::fontCharSet ( ) const
 
+/**
+ * Overloaded member function see above
+ * @see selectedFont
+ */
 bool OFontSelector::selectedFont ( QString &family, QString &style, int &size, QString &charset )
@@ -329,3 +377,5 @@ void OFontSelector::changeFont ( )
 
-
+/**
+ * Return the selected font
+ */
 QFont OFontSelector::selectedFont ( )
diff --git a/libopie/ofontselector.h b/libopie/ofontselector.h
index 10d16f0..95ffd04 100644
--- a/libopie/ofontselector.h
+++ b/libopie/ofontselector.h
@@ -28,4 +28,4 @@
 
-#ifndef __OPIE_FONTSELECTOR_H__
-#define __OPIE_FONTSELECTOR_H__
+#ifndef OPIE_FONTSELECTOR_H__
+#define OPIE_FONTSELECTOR_H__
 
@@ -36,3 +36,13 @@ class OFontSelectorPrivate;
 
-
+/**
+ * This class lets you chose a Font out of a list of Fonts.
+ * It can show a preview too. This selector will use all available
+ * fonts
+ *
+ *
+ * @short A widget to select a font
+ * @see QWidget
+ * @see QFont
+ * @author Rober Griebl
+ */
 class OFontSelector : public QWidget
@@ -59,2 +69,5 @@ public:
 signals:
+        /**
+         * This signal gets emitted when a font got chosen
+         */
 	void fontSelected ( const QFont & );
diff --git a/libopie/orecurrancewidget.cpp b/libopie/orecurrancewidget.cpp
index db86184..471249d 100644
--- a/libopie/orecurrancewidget.cpp
+++ b/libopie/orecurrancewidget.cpp
@@ -28,3 +28,11 @@ static int week( const QDate &dt );    // what week in the month is dt?
 
-
+/**
+ * Constructs the Widget
+ * @param startOnMonday Does the week start on monday
+ * @param newStart The start date of the recurrence
+ * @param parent The parent widget
+ * @param name the name of object
+ * @param modal if the dialog should be modal
+ * @param fl Additional window flags
+ */
 ORecurranceWidget::ORecurranceWidget( bool startOnMonday,
@@ -45,2 +53,13 @@ ORecurranceWidget::ORecurranceWidget( bool startOnMonday,
 }
+
+/**
+ * Different constructor
+ * @param startOnMonday Does the week start on monday?
+ * @param rp Already set ORecur object
+ * @param startDate The start date
+ * @param parent The parent widget
+ * @param name The name of the object
+ * @param modal
+ * @param fl The flags for window
+ */
 ORecurranceWidget::ORecurranceWidget( bool startOnMonday,
@@ -61,2 +80,7 @@ ORecurranceWidget::~ORecurranceWidget() {
 }
+
+/**
+ * set the start date
+ * @param date the new start date
+ */
 void ORecurranceWidget::setStartDate( const QDate& date ) {
@@ -65,2 +89,6 @@ void ORecurranceWidget::setStartDate( const QDate& date ) {
 }
+/**
+ * set the recurrence
+ * @param rp  The ORecur object with the new recurrence rules
+ */
 void ORecurranceWidget::setRecurrence( const ORecur& rp ) {
@@ -68,2 +96,8 @@ void ORecurranceWidget::setRecurrence( const ORecur& rp ) {
 }
+
+/**
+ * overloaded method taking ORecur and a new start date
+ * @param rp Recurrence rule
+ * @param date The new start date
+ */
 void ORecurranceWidget::setRecurrence( const ORecur& rp, const QDate& date ) {
@@ -125,2 +159,7 @@ void ORecurranceWidget::setRecurrence( const ORecur& rp, const QDate& date ) {
 }
+
+/**
+ * the user selected recurrence rule.
+ * @return The recurrence rule.
+ */
 ORecur ORecurranceWidget::recurrence()const {
@@ -182,2 +221,7 @@ ORecur ORecurranceWidget::recurrence()const {
 }
+
+/**
+ * Return the end date of the recurrence. This is only
+ * valid if the recurrence rule does contain an enddate
+ */
 QDate ORecurranceWidget::endDate()const {
diff --git a/libopie/orecurrancewidget.h b/libopie/orecurrancewidget.h
index 4a8dd08..af87ce9 100644
--- a/libopie/orecurrancewidget.h
+++ b/libopie/orecurrancewidget.h
@@ -19,2 +19,14 @@
 // FIXME spelling!!!! -zecke
+// FIXME spelling filenames
+
+/**
+ * A widget to let the user select rules for recurrences.
+ * This widget can take care of weekly, monthly, daily and yearly recurrence
+ * It is used inside todolist and datebook.
+ *
+ *
+ * @short Widget of selecting Recurrance
+ * @author Trolltech, Holger Freyther
+ * @version 0.9
+ */
 class ORecurranceWidget : public ORecurranceBase {
diff --git a/libopie/otabbar.h b/libopie/otabbar.h
index 16797a3..c413611 100644
--- a/libopie/otabbar.h
+++ b/libopie/otabbar.h
@@ -59,2 +59,3 @@ public:
  */
+ // FIXME Allow WFlags? -zecke
     OTabBar( QWidget * = 0, const char * = 0 );
diff --git a/libopie/otabwidget.h b/libopie/otabwidget.h
index 0aa9bb8..23fe774 100644
--- a/libopie/otabwidget.h
+++ b/libopie/otabwidget.h
@@ -101,2 +101,3 @@ public:
  */
+ // FIXME WFlags? -zecke
     OTabWidget( QWidget * = 0, const char * = 0, TabStyle = Global, TabPosition = Top );
@@ -199,2 +200,3 @@ public:
  */
+ //FIXME TT coding style currentTab() -zecke
     int getCurrentTab();
diff --git a/libopie/oticker.h b/libopie/oticker.h
index 5df08da..30b7517 100644
--- a/libopie/oticker.h
+++ b/libopie/oticker.h
@@ -42,3 +42,4 @@
 #include <qcolor.h>
-/*!
+
+/**
  * @class OTicker
@@ -48,3 +49,2 @@
 class OTicker : public QLabel {
-//class OTicker : public QFrame {
     Q_OBJECT
diff --git a/libopie/otimepicker.cpp b/libopie/otimepicker.cpp
index 8e8a4e7..115d39b 100644
--- a/libopie/otimepicker.cpp
+++ b/libopie/otimepicker.cpp
@@ -9,2 +9,9 @@
 
+
+/**
+ * Constructs the widget
+ * @param parent The parent of the OTimePicker
+ * @param name The name of the object
+ * @param fl Window Flags
+ */
 OTimePicker::OTimePicker(QWidget* parent, const char* name, 
@@ -13,2 +20,3 @@ OTimePicker::OTimePicker(QWidget* parent, const char* name,
 {
+
   QVBoxLayout *vbox=new QVBoxLayout(this);
@@ -60,2 +68,10 @@ OTimePicker::OTimePicker(QWidget* parent, const char* name,
 
+/**
+ * This method return the current time
+ * @return the time
+ */
+QTime OTimePicker::time()const {
+    return tm;
+}
+
 void OTimePicker::slotHour(bool b) {
@@ -94,2 +110,28 @@ void OTimePicker::slotMinute(bool b) {
 
+/**
+ * Method to set the time. No signal gets emitted during this method call
+ * Minutes must be within 5 minutes step starting at 0 ( 0,5,10,15,20... )
+ * @param t The time to be set
+ */
+void OTimePicker::setTime( const QTime& t) {
+    setTime( t.hour(), t.minute() );
+}
+
+/**
+ * Method to set the time. No signal gets emitted during this method call
+ * @param h The hour
+ * @param m The minute. Minutes need to set by 5 minute steps
+ */
+void OTimePicker::setTime( int h,  int m ) {
+    setHour(h);
+    setMinute(m);
+}
+
+/*
+ * FIXME round minutes to the 5 minute arrangement -zecke
+ */
+/**
+ * Method to set the minutes
+ * @param m minutes
+ */
 void OTimePicker::setMinute(int m) {
@@ -108,2 +150,5 @@ void OTimePicker::setMinute(int m) {
 
+/**
+ * Method to set the hour
+ */
 void OTimePicker::setHour(int h) {
@@ -122,2 +167,9 @@ void OTimePicker::setHour(int h) {
 
+/**
+ * This is a modal Dialog.
+ *
+ * @param parent The parent widget
+ * @param name The name of the object
+ * @param fl Possible window flags
+ */
 OTimePickerDialog::OTimePickerDialog ( QWidget* parent, const char* name, WFlags fl )
@@ -135,3 +187,6 @@ OTimePickerDialog::OTimePickerDialog ( QWidget* parent, const char* name, WFlags
 
-QTime& OTimePickerDialog::time()
+/**
+ * @return the time
+ */
+QTime OTimePickerDialog::time()const
 {
@@ -139,2 +194,7 @@ QTime& OTimePickerDialog::time()
 }
+
+/**
+ * Set the time to time
+ * @param time The time to be set
+ */
 void OTimePickerDialog::setTime( const QTime& time )
@@ -159,2 +219,7 @@ void OTimePickerDialog::setTime( const QTime& time )
 
+/**
+ * This method takes the current minute and tries to set hour
+ * to hour. This succeeds if the resulting date is valid
+ * @param hour The hour as a string
+ */
 void OTimePickerDialog::setHour ( const QString& hour )
@@ -168,2 +233,7 @@ void OTimePickerDialog::setHour ( const QString& hour )
 
+/**
+ * Method to set a new minute. It tries to convert the string to int and
+ * if the resulting date is valid a new date is set.
+ * @see setHour
+ */
 void OTimePickerDialog::setMinute ( const QString& minute )
diff --git a/libopie/otimepicker.h b/libopie/otimepicker.h
index 825e2d6..495c806 100644
--- a/libopie/otimepicker.h
+++ b/libopie/otimepicker.h
@@ -11,2 +11,13 @@
 
+/**
+ * A class to pick time. It uses clickable labels
+ * internally to allow a quick selection of a time.
+ * A time can be selected by two clicks of a user
+ *
+ * @short A widget to quickly pick a QTime
+ * @version 1.0
+ * @see QWidget
+ * @see QTime
+ * @author Hakan Ardo, Stefan Eilers
+ */
 class OTimePicker: public QWidget {
@@ -17,4 +28,11 @@ class OTimePicker: public QWidget {
 	       WFlags fl = 0);
+ 
+ public slots:	      
     void setHour(int h);
     void setMinute(int m);
+    void setTime( const QTime& );
+    void setTime( int h,  int m );
+    
+ public:
+    QTime time()const;
 
@@ -24,2 +42,4 @@ class OTimePicker: public QWidget {
     QTime tm;
+    struct Private;
+    Private *d;
 
@@ -30,2 +50,5 @@ class OTimePicker: public QWidget {
  signals:
+    /**
+     * gets emitted when the time got changed by the user
+     */
     void timeChanged(const QTime &);
@@ -33,2 +56,9 @@ class OTimePicker: public QWidget {
 
+/**
+ *
+ * @short
+ * @version 1.0
+ * @author Stefan Eilers
+ */
+
 class OTimePickerDialog: public OTimePickerDialogBase {
@@ -40,3 +70,3 @@ class OTimePickerDialog: public OTimePickerDialogBase {
 
-	QTime& time();
+	QTime time()const;
 
diff --git a/libopie/owait.cpp b/libopie/owait.cpp
index c90bb72..0fdf08d 100644
--- a/libopie/owait.cpp
+++ b/libopie/owait.cpp
@@ -31,4 +31,14 @@ static int frame = 0;
 
+/**
+ * This will construct a modal dialog.
+ *
+ * The default timer length is 10.
+ *
+ * @param parent The parent of the widget
+ * @param msg The name of the object
+ * @param dispIcon Display Icon?
+ */
 OWait::OWait(QWidget *parent, const char* msg, bool dispIcon )
-  :QDialog(parent, QObject::tr("Wait"), TRUE,WStyle_Customize) {
+  :QDialog(parent, msg, TRUE,WStyle_Customize) {
+
 
diff --git a/libopie/owait.h b/libopie/owait.h
index d22e141..6217e31 100644
--- a/libopie/owait.h
+++ b/libopie/owait.h
@@ -31,2 +31,6 @@
  * This class displays a animated waiting icon in the middle of the screen.
+ *
+ * @short modal hour glass dialog
+ * @see QDialog
+ * @author Maximilian Reiß
  */
@@ -37,3 +41,3 @@ class OWait : public QDialog {
 public:
-    OWait(QWidget *parent=0,const char* msg=0,bool dispIcon=TRUE);
+    OWait(QWidget *parent=0,const char* name=0, bool dispIcon=TRUE);
     ~OWait();
@@ -47,2 +51,3 @@ public:
      * Set the time before the icon will be automaticly hidden
+     * The timer will be started once the widget will be shown.
      * @param length - time in seconds
diff --git a/libopie/todayconfigwidget.h b/libopie/todayconfigwidget.h
index 48cf379..6b49efc 100644
--- a/libopie/todayconfigwidget.h
+++ b/libopie/todayconfigwidget.h
@@ -5,2 +5,13 @@
 
+/**
+ * A base class for all Today Config Widgets.
+ * This will let a Today plugin to add the possibility of configuration.
+ * Plugins need to inherit from this class and need to implement
+ * the pure virtual method to control configuration.
+ * The Plugin should read its configuration during creation of the Widget
+ *
+ *
+ * @author Maximilian Reiß
+ * @short base class of all today config widgets
+ */
 class TodayConfigWidget : public QWidget {
@@ -10,2 +21,9 @@ public:
 
+    /**
+     * This will construct the widget. The widget gets deleted once the parent
+     * gets deleted as in any Qt application
+     *
+     * @param parent The parent of the widget
+     * @paran name The name of the object
+     */
     TodayConfigWidget( QWidget *parent,  const char *name ) : QWidget( parent,  name ) {} ;
diff --git a/libopie/todayplugininterface.h b/libopie/todayplugininterface.h
index 6ee2a06..29a12bc 100644
--- a/libopie/todayplugininterface.h
+++ b/libopie/todayplugininterface.h
@@ -16,3 +16,8 @@ class QWidget;
  *
+ * A TodayPluginObject is the base for all Today Plugins.
+ * A plugin author needs to inherit this class and implement
+ * the pure virtual methods
  *
+ * @short base class for today plugins
+ * @author Maximilian Reiss
  *
@@ -27,2 +32,3 @@ public:
      * The name if the plugin
+     * @return The plugin should return its name here
      */
@@ -32,2 +38,3 @@ public:
      * Version numbering
+     * @return The plugin should return the version number
      */
@@ -36,8 +43,13 @@ public:
 
+    /**
+     * @return the pixmap name widget?! -- FIXME
+     */
     virtual  QString pixmapNameWidget() const = 0;
 
-    /**    widget for the today view
+    /**
+     * widget for the today view
      * It _needs_ a parent here.
+     * Plugin authors need to take parent as parent!
      */
-    virtual QWidget* widget( QWidget * ) = 0;
+    virtual QWidget* widget( QWidget *parent ) = 0;
 
@@ -51,2 +63,3 @@ public:
      * If the plugin has a config widget, it  _needs_  a parent here.
+     * may return 0 if no config widget is needed
      */
@@ -56,2 +69,4 @@ public:
      * The application that should be assigned to the button (pixmap)
+     * Today will show the plugin icon. On click it tries to execute the
+     * plugin related application.
      */
@@ -83,3 +98,5 @@ public:
 
-
+/**
+ * This is part of the QCOM works. See example plugins how to do it right
+ */
 struct TodayPluginInterface : public QUnknownInterface {