API docu fixes...

if using \fn infront of a function make sure to name the right function
ljp please see my comment in oticker about constness

18 files changed, 93 insertions, 45 deletions

diff --git a/libopie/colordialog.cpp b/libopie/colordialog.cpp
index 35f15d6..c7421ec 100644
--- a/libopie/colordialog.cpp
+++ b/libopie/colordialog.cpp
@@ -692,7 +692,7 @@ OColorDialogPrivate::OColorDialogPrivate( OColorDialog *dialog ) :
 
 // BEING REVISED: jo
 /*!
-  \class OColorDialog OColorDialog.h
+  \class ColorDialog ColorDialog.h
   \brief The OColorDialog class provides a dialog widget for specifying colors.
   \ingroup dialogs
 
diff --git a/libopie/colordialog.h b/libopie/colordialog.h
index e9bb7ed..1a6a3fd 100644
--- a/libopie/colordialog.h
+++ b/libopie/colordialog.h
@@ -44,7 +44,7 @@
 
 class OColorDialogPrivate;
 
-/**
+/*
  * @class OColorDialog
  * @brief The OColorDialog class is a copy of QColorDialog for use in Opie.
  *
@@ -61,7 +61,7 @@ class Q_EXPORT OColorDialog : public QDialog
     Q_OBJECT
 
 public:
-    static QColor getColor( const QColor&, QWidget *parent=0, const char* name=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 );
 
diff --git a/libopie/colorpopupmenu.h b/libopie/colorpopupmenu.h
index 184b132..3e90c5e 100644
--- a/libopie/colorpopupmenu.h
+++ b/libopie/colorpopupmenu.h
@@ -68,7 +68,7 @@ public:
     OColorPanelButton(const QColor& color, QWidget* parent = 0, const char* name = 0);
 
 /**
- * @fn ~ColorPanelButton()
+ * @fn ~OColorPanelButton()
  * @brief Object destructor.
  */
     ~OColorPanelButton();
@@ -107,11 +107,11 @@ public:
     void leaveEvent(QEvent* e);
 
 /**
- * @fn paintEvent( QEvent* e )
+ * @fn paintEvent( QPaintEvent* e )
  * @brief Reimplemented for internal reasons.
  *
  * @param e Event currently being processed.
- *
+ * @reimp
  * Reimplemented to ensure correct display of button.
  */
     void paintEvent(QPaintEvent* e);
diff --git a/libopie/ocheckitem.h b/libopie/ocheckitem.h
index 2387134..82ee3d0 100644
--- a/libopie/ocheckitem.h
+++ b/libopie/ocheckitem.h
@@ -29,15 +29,24 @@
 class OCheckItem : public QTableItem
 {
 public:
+    /** The size of a box currently unused */
     enum Size { BoxSize = 10 };
     OCheckItem( QTable *t, const QString &sortkey );
 
     virtual void setChecked( bool b );
     virtual void toggle();
     bool isChecked() const;
+    /**
+     * @short Set the sort key
+     * @reimp
+     */
     void setKey( const QString &key ) { m_sortKey = key; }
     virtual QString key() const;
 
+    /**
+     * foo
+     * @internal
+     */
     void paint( QPainter *p, const QColorGroup &cg, const QRect &cr, bool selected );
 
     //static const int BoxSize = 10;
diff --git a/libopie/oclickablelabel.h b/libopie/oclickablelabel.h
index 4b6dcbc..6e7a123 100644
--- a/libopie/oclickablelabel.h
+++ b/libopie/oclickablelabel.h
@@ -32,14 +32,25 @@ public:
     void setToggleButton(bool t);
 
  protected:
+    /** @internal */
     void mousePressEvent( QMouseEvent *e );
+    /** @internal */
     void mouseReleaseEvent( QMouseEvent *e );
+    /** @internal */
     void mouseMoveEvent( QMouseEvent *e );
 
  public slots:
     void setOn(bool on);
  signals:
+    /**
+     * emitted when the labels gets clicked
+     */
     void clicked();
+
+    /**
+     * emitted when the labels gets toggled
+     * @param the new new state of the label
+     */
     void toggled(bool on);
  private:
     bool isToggle : 1;
diff --git a/libopie/ocolorbutton.h b/libopie/ocolorbutton.h
index 338e654..7ff9cd2 100644
--- a/libopie/ocolorbutton.h
+++ b/libopie/ocolorbutton.h
@@ -50,12 +50,18 @@ public:
         QColor color ( ) const;
 
 signals:
+    /**
+     * emitted when a color gets selected
+     */
         void colorSelected ( const QColor & );
 
 public slots:
         virtual void setColor ( const QColor & );
 
 protected slots:
+    /**
+     * @internal
+     */
         virtual void updateColor ( const QColor & );
 
 private:
diff --git a/libopie/odevicebutton.cpp b/libopie/odevicebutton.cpp
index 4b22358..eccb57c 100644
--- a/libopie/odevicebutton.cpp
+++ b/libopie/odevicebutton.cpp
@@ -28,20 +28,20 @@ using namespace Opie;
 
 
 class OQCopMessageData {
-        public:
+public:
         QCString m_channel;
         QCString m_message;
         QByteArray m_data;
 };
 
 
-OQCopMessage::OQCopMessage ( ) 
+OQCopMessage::OQCopMessage ( )
         : d ( 0 )
 {
         init ( QCString ( ), QCString ( ), QByteArray ( ));
 }
 
-OQCopMessage::OQCopMessage ( const OQCopMessage &copy ) 
+OQCopMessage::OQCopMessage ( const OQCopMessage &copy )
         : d ( 0 )
 {
         init ( copy. channel ( ), copy. message ( ), copy. data ( ));
@@ -53,7 +53,7 @@ OQCopMessage &OQCopMessage::operator = ( const OQCopMessage &assign )
         return *this;
 }
 
-OQCopMessage::OQCopMessage ( const QCString &ch, const QCString &m, const QByteArray &arg ) 
+OQCopMessage::OQCopMessage ( const QCString &ch, const QCString &m, const QByteArray &arg )
         : d ( 0 )
 {
         init ( ch, m, arg );
@@ -74,7 +74,7 @@ bool OQCopMessage::send ( )
                 return false;
 
         QCopEnvelope e ( d-> m_channel, d-> m_message );
-        
+
         if ( d-> m_data. size ( ))
                 e. writeRawBytes ( d-> m_data. data ( ), d-> m_data. size ( ));
 
@@ -111,8 +111,8 @@ void OQCopMessage::setData ( const QByteArray &data )
         d-> m_data = data;
 }
 
-/*! \class ODeviceButton
-    \brief The ODeviceButton class represents a physical user mappable button on a Qtopia device.
+/*! \class Opie::ODeviceButton
+    \brief The Opie::ODeviceButton class represents a physical user mappable button on a Qtopia device.
 
     This class represents a physical button on a Qtopia device.    A
     device may have "user programmable" buttons.
diff --git a/libopie/ofileselector.h b/libopie/ofileselector.h
index 06ac806..d06aa0a 100644
--- a/libopie/ofileselector.h
+++ b/libopie/ofileselector.h
@@ -44,13 +44,7 @@
 #include <qpe/applnk.h>
 #include <qlistview.h>
 
-/** This is OPIEs FileDialog Widget. You can use it
- *  as a dropin replacement of the fileselector and
- *  or use any of the new features.
- *  This is also a complete FileSave and FileLoad widget
- *  If you look for a Dialog check OFileDialog
- *
- */
+
 class DocLnk;
 class QCheckBox;
 class QComboBox;
@@ -69,6 +63,15 @@ class QHBox;
 
 typedef QMap< QString, QStringList> MimeTypes;
 
+/**
+ *  This is OPIEs FileDialog Widget. You can use it
+ *  as a dropin replacement of the fileselector and
+ *  or use any of the new features.
+ *  This is also a complete FileSave and FileLoad widget
+ *  If you look for a Dialog check OFileDialog
+ *
+ * NOTE THAT the API will change to be more extendable!
+ */
 class OFileSelector : public QWidget {
   Q_OBJECT
  public:
diff --git a/libopie/ofontselector.h b/libopie/ofontselector.h
index 95ffd04..b819c45 100644
--- a/libopie/ofontselector.h
+++ b/libopie/ofontselector.h
@@ -73,8 +73,11 @@ signals:
         void fontSelected ( const QFont & );
 
 protected slots:
+    /** @internal */
     virtual void fontFamilyClicked ( int );
+    /** @internal */
     virtual void fontStyleClicked ( int );
+    /** @internal */
     virtual void fontSizeClicked ( int );
 
 protected:
diff --git a/libopie/oprocess.h b/libopie/oprocess.h
index bf5fe0e..f2853b0 100644
--- a/libopie/oprocess.h
+++ b/libopie/oprocess.h
@@ -46,7 +46,7 @@ class OProcessPrivate;
  *
  * @sect General usage and features
  *
- *This class allows a KDE application to start child processes without having
+ *This class allows a KDE and OPIE application to start child processes without having
  *to worry about UN*X signal handling issues and zombie process reaping.
  *
  *@see KProcIO
@@ -188,7 +188,13 @@ public:
    * Constructor
    */
   OProcess(QObject *parent = 0, const char *name = 0);
+  /**
+   * Constructor
+   */
   OProcess(const QString &arg0, QObject *parent = 0, const char *name = 0);
+  /**
+   * Constructor
+   */
   OProcess(const QStringList &args, QObject *parent = 0, const char *name = 0);
 
   /**
@@ -410,7 +416,7 @@ public:
    * setuid/segid privileges or whether it will keep them
    */
   bool runPrivileged() const;
-  
+
   /**
    * Modifies the environment of the process to be started.
    * This function must be called before starting the process.
@@ -418,7 +424,7 @@ public:
   void setEnvironment(const QString &name, const QString &value);
 
   /**
-   * Changes the current working directory (CWD) of the process 
+   * Changes the current working directory (CWD) of the process
    * to be started.
    * This function must be called before starting the process.
    */
@@ -452,7 +458,7 @@ public:
    * Note that the current process remains the parent process of the
    * child process.
    */
-  void detach(); 
+  void detach();
 
 
 
@@ -486,15 +492,15 @@ signals:
    * Emitted when output from the child process has
    * been received on stdout.
    *
-   * To actually get these signals, the respective communications link 
-   * (stdout/stderr) has to be turned on in @ref start() and the 
+   * To actually get these signals, the respective communications link
+   * (stdout/stderr) has to be turned on in @ref start() and the
    * @p NoRead flag should have been passed.
    *
    * You will need to explicitly call resume() after your call to start()
    * to begin processing data from the child process's stdout.  This is
    * to ensure that this signal is not emitted when no one is connected
    * to it, otherwise this signal will not be emitted.
-   * 
+   *
    * The data still has to be read from file descriptor @p fd.
    **/
   void receivedStdout(int fd, int &len);
@@ -550,7 +556,7 @@ protected slots:
 protected:
 
   /**
-   * Sets up the environment according to the data passed via 
+   * Sets up the environment according to the data passed via
    * setEnvironment(...)
    */
   void setupEnvironment();
@@ -712,7 +718,7 @@ protected:
 
 private:
   /**
-   * Searches for a valid shell. 
+   * Searches for a valid shell.
    * Here is the algorithm used for finding an executable shell:
    *
    *    @li Try the executable pointed to by the "SHELL" environment
diff --git a/libopie/orecurrancewidget.h b/libopie/orecurrancewidget.h
index af87ce9..a5d6489 100644
--- a/libopie/orecurrancewidget.h
+++ b/libopie/orecurrancewidget.h
@@ -46,7 +46,13 @@ public:
 
 public slots:
     void slotSetRType( int );
+    /**
+     * set the new end date
+     */
     void endDateChanged( int, int, int );
+    /**
+     * enable/disable end date
+     */
     void slotNoEnd( bool unused );
     void setStartDate( const QDate& );
     void setRecurrence( const ORecur& recur, const QDate& start );
diff --git a/libopie/otabbar.h b/libopie/otabbar.h
index c413611..0b353e2 100644
--- a/libopie/otabbar.h
+++ b/libopie/otabbar.h
@@ -62,7 +62,7 @@ public:
 
 protected:
 /**
- * @fn paintLabel( QPainter* p, const QRect& br, QTab* t, bool has_focus )
+ * @fn paintLabel( QPainter* p, const QRect& br , QTab* t, bool  has_focus)const
  * @brief Internal function to draw a tab's label.
  *
  * @param p Pointer to QPainter used for drawing.
diff --git a/libopie/otabinfo.h b/libopie/otabinfo.h
index 6589638..eebaf8e 100644
--- a/libopie/otabinfo.h
+++ b/libopie/otabinfo.h
@@ -77,13 +77,13 @@ public:
         : i( id ), c( control ), p( icon ), l( label ) {}
 
 /**
- * @fn id()
+ * @fn id()const
  * @brief Returns TabBar ID.
  */
     int            id()      const { return i; }
 
 /**
- * @fn label()
+ * @fn label()const
  * @brief Returns text label for widget.
  */
     const QString &label()   const { return l; }
@@ -97,13 +97,13 @@ public:
     void setLabel( const QString &label ) { l = label; }
 
 /**
- * @fn control()
+ * @fn control()const
  * @brief Returns pointer to widget.
  */
     QWidget       *control() const { return c; }
 
 /**
- * @fn icon()
+ * @fn icon()const
  * @brief Returns name of icon file.
  */
     const QString &icon()    const { return p; }
diff --git a/libopie/otabwidget.h b/libopie/otabwidget.h
index bcd9a85..a67fe06 100644
--- a/libopie/otabwidget.h
+++ b/libopie/otabwidget.h
@@ -127,7 +127,7 @@ public:
     void removePage( QWidget * );
 
 /**
- * @fn changeTab( QWidget *widget, const QIconSet &icon, const QString &label )
+ * @fn changeTab( QWidget *widget, const QString &icon, const QString &label )
  * @brief Change text and/or icon for existing tab
  *
  * @param child Widget control.
@@ -137,7 +137,7 @@ public:
     void changeTab( QWidget *, const QString &, const QString & );
 
 /**
- * @fn tabStyle()
+ * @fn tabStyle()const
  * @brief Returns current widget selection control style.
  */
     TabStyle tabStyle() const;
@@ -151,7 +151,7 @@ public:
     void setTabStyle( TabStyle );
 
 /**
- * @fn tabPosition()
+ * @fn tabPosition()const
  * @brief Returns current widget selection control position.
  */
     TabPosition tabPosition() const;
@@ -189,7 +189,7 @@ public:
     void setCurrentTab(int);
 
 /**
- * @fn sizeHint()
+ * @fn sizeHint()const
  * @brief Reimplemented for internal purposes.
  */
     QSize sizeHint() const;
@@ -244,7 +244,7 @@ private:
  */
     void    setUpLayout();
 
-    
+
 signals:
 /**
  * @fn currentChanegd( QWidget *widget )
diff --git a/libopie/oticker.h b/libopie/oticker.h
index 30b7517..c848654 100644
--- a/libopie/oticker.h
+++ b/libopie/oticker.h
@@ -66,7 +66,7 @@ public:
  */
     ~OTicker();
 /*!
- * @fn setText()
+ * @fn setText(const QString& )
  * @brief sets text to be displayed
  * @param text QString text to be displayed.
  *
@@ -78,6 +78,7 @@ public:
  * @param color QColor color to be set.
  *
  */
+    //FIXME const QColor& please -zecke
     void setBackgroundColor(QColor color);
 /*!
  * @fn setForegroundColor(QColor color)
diff --git a/libopie/otimepicker.h b/libopie/otimepicker.h
index 495c806..d501a95 100644
--- a/libopie/otimepicker.h
+++ b/libopie/otimepicker.h
@@ -26,13 +26,13 @@ class OTimePicker: public QWidget {
  public:
     OTimePicker(QWidget* parent = 0, const char* name = 0,
                WFlags fl = 0);
- 
-         public slots:      
+
+ public slots:
     void setHour(int h);
     void setMinute(int m);
     void setTime( const QTime& );
     void setTime( int h,  int m );
-    
+
  public:
     QTime time()const;
 
@@ -56,7 +56,7 @@ class OTimePicker: public QWidget {
 
 /**
  *
- * @short
+ * @short A small dialog to pick a time
  * @version 1.0
  * @author Stefan Eilers
  */
diff --git a/libopie/todayconfigwidget.h b/libopie/todayconfigwidget.h
index 6b49efc..f3501a1 100644
--- a/libopie/todayconfigwidget.h
+++ b/libopie/todayconfigwidget.h
@@ -24,7 +24,7 @@ public:
      * gets deleted as in any Qt application
      *
      * @param parent The parent of the widget
-     * @paran name The name of the object
+     * @param name The name of the object
      */
     TodayConfigWidget( QWidget *parent,  const char *name ) : QWidget( parent,  name ) {} ;
     virtual ~TodayConfigWidget() {};
diff --git a/libopie/todayplugininterface.h b/libopie/todayplugininterface.h
index 29a12bc..532f492 100644
--- a/libopie/todayplugininterface.h
+++ b/libopie/todayplugininterface.h
@@ -100,6 +100,9 @@ public:
  * This is part of the QCOM works. See example plugins how to do it right
  */
 struct TodayPluginInterface : public QUnknownInterface {
+    /**
+     * return the TodayPluginObject implementation
+     */
     virtual TodayPluginObject *guiPart() = 0;
 };