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
@@ -691,9 +691,9 @@ 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
 
   The color dialog's function is to allow users to choose colors -
diff --git a/libopie/colordialog.h b/libopie/colordialog.h
index e9bb7ed..1a6a3fd 100644
--- a/libopie/colordialog.h
+++ b/libopie/colordialog.h
@@ -43,9 +43,9 @@
 #endif // QT_H
 
 class OColorDialogPrivate;
 
-/**
+/*
  * @class OColorDialog
  * @brief The OColorDialog class is a copy of QColorDialog for use in Opie.
  *
  * OColorDialog is a copy of TrollTech's QColorDialog for use in Opie.  The default
@@ -60,9 +60,9 @@ 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 );
 
 private:
diff --git a/libopie/colorpopupmenu.h b/libopie/colorpopupmenu.h
index 184b132..3e90c5e 100644
--- a/libopie/colorpopupmenu.h
+++ b/libopie/colorpopupmenu.h
@@ -67,9 +67,9 @@ public:
  */
     OColorPanelButton(const QColor& color, QWidget* parent = 0, const char* name = 0);
 
 /**
- * @fn ~ColorPanelButton()
+ * @fn ~OColorPanelButton()
  * @brief Object destructor.
  */
     ~OColorPanelButton();
 
@@ -106,13 +106,13 @@ 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
@@ -28,17 +28,26 @@
 
 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
@@ -31,16 +31,27 @@ public:
 		   WFlags fl = 0);
     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;
     bool isDown : 1;
diff --git a/libopie/ocolorbutton.h b/libopie/ocolorbutton.h
index 338e654..7ff9cd2 100644
--- a/libopie/ocolorbutton.h
+++ b/libopie/ocolorbutton.h
@@ -49,14 +49,20 @@ 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:
 	OColorButtonPrivate *d;
diff --git a/libopie/odevicebutton.cpp b/libopie/odevicebutton.cpp
index 4b22358..eccb57c 100644
--- a/libopie/odevicebutton.cpp
+++ b/libopie/odevicebutton.cpp
@@ -27,22 +27,22 @@
 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 ( ));
 }
@@ -52,9 +52,9 @@ OQCopMessage &OQCopMessage::operator = ( const OQCopMessage &assign )
 	init ( assign. channel ( ), assign. message ( ), assign. data ( ));
 	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 );
 }
@@ -73,9 +73,9 @@ bool OQCopMessage::send ( )
 	if ( d-> m_channel. isEmpty ( ) || d-> m_message. isEmpty ( ) )
 		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 ( ));
 
 	return true;
@@ -110,10 +110,10 @@ 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.
     The location and number of buttons will vary from device to
diff --git a/libopie/ofileselector.h b/libopie/ofileselector.h
index 06ac806..d06aa0a 100644
--- a/libopie/ofileselector.h
+++ b/libopie/ofileselector.h
@@ -43,15 +43,9 @@
 
 #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;
 class QPushButton;
@@ -68,8 +62,17 @@ 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
@@ -72,10 +72,13 @@ signals:
          */
 	void fontSelected ( const QFont & );
 
 protected slots:
+    /** @internal */
     virtual void fontFamilyClicked ( int );
+    /** @internal */
     virtual void fontStyleClicked ( int );
+    /** @internal */
     virtual void fontSizeClicked ( int );
 
 protected:
 	virtual void resizeEvent ( QResizeEvent *re );
diff --git a/libopie/oprocess.h b/libopie/oprocess.h
index bf5fe0e..f2853b0 100644
--- a/libopie/oprocess.h
+++ b/libopie/oprocess.h
@@ -45,9 +45,9 @@ class OProcessPrivate;
  * Child process invocation, monitoring and control.
  *
  * @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
  *
@@ -187,9 +187,15 @@ 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);
 
   /**
    *Destructor:
@@ -409,17 +415,17 @@ public:
    * Returns whether the started process will drop any
    * 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.
    */
   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.
    */
   void setWorkingDirectory(const QString &dir);
@@ -451,9 +457,9 @@ public:
    * Deleting the OProcess will no longer kill the child process.
    * Note that the current process remains the parent process of the
    * child process.
    */
-  void detach(); 
+  void detach();
 
 
 
 signals:
@@ -485,17 +491,17 @@ 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);
 
@@ -549,9 +555,9 @@ 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();
 
@@ -711,9 +717,9 @@ 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
    *    variable with white spaces stripped off
diff --git a/libopie/orecurrancewidget.h b/libopie/orecurrancewidget.h
index af87ce9..a5d6489 100644
--- a/libopie/orecurrancewidget.h
+++ b/libopie/orecurrancewidget.h
@@ -45,9 +45,15 @@ public:
     QDate endDate()const;
 
 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 );
     void setRecurrence( const ORecur& recur );
diff --git a/libopie/otabbar.h b/libopie/otabbar.h
index c413611..0b353e2 100644
--- a/libopie/otabbar.h
+++ b/libopie/otabbar.h
@@ -61,9 +61,9 @@ public:
     OTabBar( QWidget * = 0, const char * = 0 );
 
 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.
  * @param br QRect providing region to draw label in.
diff --git a/libopie/otabinfo.h b/libopie/otabinfo.h
index 6589638..eebaf8e 100644
--- a/libopie/otabinfo.h
+++ b/libopie/otabinfo.h
@@ -76,15 +76,15 @@ public:
     OTabInfo( int id, QWidget *control, const QString &icon, const QString &label )
         : 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; }
 
@@ -96,15 +96,15 @@ 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
@@ -126,9 +126,9 @@ 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.
  * @param icon Path to icon.
@@ -136,9 +136,9 @@ public:
  */
     void changeTab( QWidget *, const QString &, const QString & );
 
 /**
- * @fn tabStyle()
+ * @fn tabStyle()const
  * @brief Returns current widget selection control style.
  */
     TabStyle tabStyle() const;
 
@@ -150,9 +150,9 @@ public:
  */
     void setTabStyle( TabStyle );
 
 /**
- * @fn tabPosition()
+ * @fn tabPosition()const
  * @brief Returns current widget selection control position.
  */
     TabPosition tabPosition() const;
 
@@ -188,9 +188,9 @@ public:
  */
     void setCurrentTab(int);
 
 /**
- * @fn sizeHint()
+ * @fn sizeHint()const
  * @brief Reimplemented for internal purposes.
  */
     QSize sizeHint() const;
 
@@ -243,9 +243,9 @@ private:
  * @brief Internal function to adjust layout.
  */
     void    setUpLayout();
 
-    
+
 signals:
 /**
  * @fn currentChanegd( QWidget *widget )
  * @brief This signal is emitted whenever the widget has changed.
diff --git a/libopie/oticker.h b/libopie/oticker.h
index 30b7517..c848654 100644
--- a/libopie/oticker.h
+++ b/libopie/oticker.h
@@ -65,9 +65,9 @@ public:
  * @brief Object destructor.
  */
     ~OTicker();
 /*!
- * @fn setText()
+ * @fn setText(const QString& )
  * @brief sets text to be displayed
  * @param text QString text to be displayed.
  *
  */
@@ -77,8 +77,9 @@ public:
  * @brief sets color of the ticker's background
  * @param color QColor color to be set.
  *
  */
+    //FIXME const QColor& please -zecke
     void setBackgroundColor(QColor color);
 /*!
  * @fn setForegroundColor(QColor color)
  * @brief sets color of text
diff --git a/libopie/otimepicker.h b/libopie/otimepicker.h
index 495c806..d501a95 100644
--- a/libopie/otimepicker.h
+++ b/libopie/otimepicker.h
@@ -25,15 +25,15 @@ 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;
 
  private:
@@ -55,9 +55,9 @@ 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
@@ -23,9 +23,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
+     * @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
@@ -99,8 +99,11 @@ 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;
 };
 
 #endif