-rw-r--r-- | libopie/colordialog.cpp | 2 | ||||
-rw-r--r-- | libopie/colordialog.h | 2 | ||||
-rw-r--r-- | libopie/colorpopupmenu.h | 6 | ||||
-rw-r--r-- | libopie/ocheckitem.h | 9 | ||||
-rw-r--r-- | libopie/oclickablelabel.h | 11 | ||||
-rw-r--r-- | libopie/ocolorbutton.h | 6 | ||||
-rw-r--r-- | libopie/odevicebutton.cpp | 4 | ||||
-rw-r--r-- | libopie/ofileselector.h | 17 | ||||
-rw-r--r-- | libopie/ofontselector.h | 3 | ||||
-rw-r--r-- | libopie/oprocess.h | 8 | ||||
-rw-r--r-- | libopie/orecurrancewidget.h | 6 | ||||
-rw-r--r-- | libopie/otabbar.h | 2 | ||||
-rw-r--r-- | libopie/otabinfo.h | 8 | ||||
-rw-r--r-- | libopie/otabwidget.h | 8 | ||||
-rw-r--r-- | libopie/oticker.h | 3 | ||||
-rw-r--r-- | libopie/otimepicker.h | 2 | ||||
-rw-r--r-- | libopie/todayconfigwidget.h | 2 | ||||
-rw-r--r-- | libopie/todayplugininterface.h | 3 |
18 files changed, 75 insertions, 27 deletions
diff --git a/libopie/colordialog.cpp b/libopie/colordialog.cpp index 35f15d6..c7421ec 100644 --- a/libopie/colordialog.cpp +++ b/libopie/colordialog.cpp @@ -694,3 +694,3 @@ OColorDialogPrivate::OColorDialogPrivate( OColorDialog *dialog ) : /*! - \class OColorDialog OColorDialog.h + \class ColorDialog ColorDialog.h \brief The OColorDialog class provides a dialog widget for specifying colors. diff --git a/libopie/colordialog.h b/libopie/colordialog.h index e9bb7ed..1a6a3fd 100644 --- a/libopie/colordialog.h +++ b/libopie/colordialog.h @@ -46,3 +46,3 @@ class OColorDialogPrivate; -/** +/* * @class OColorDialog diff --git a/libopie/colorpopupmenu.h b/libopie/colorpopupmenu.h index 184b132..3e90c5e 100644 --- a/libopie/colorpopupmenu.h +++ b/libopie/colorpopupmenu.h @@ -70,3 +70,3 @@ public: /** - * @fn ~ColorPanelButton() + * @fn ~OColorPanelButton() * @brief Object destructor. @@ -109,3 +109,3 @@ public: /** - * @fn paintEvent( QEvent* e ) + * @fn paintEvent( QPaintEvent* e ) * @brief Reimplemented for internal reasons. @@ -113,3 +113,3 @@ public: * @param e Event currently being processed. - * + * @reimp * Reimplemented to ensure correct display of button. diff --git a/libopie/ocheckitem.h b/libopie/ocheckitem.h index 2387134..82ee3d0 100644 --- a/libopie/ocheckitem.h +++ b/libopie/ocheckitem.h @@ -31,2 +31,3 @@ class OCheckItem : public QTableItem public: + /** The size of a box currently unused */ enum Size { BoxSize = 10 }; @@ -37,2 +38,6 @@ public: bool isChecked() const; + /** + * @short Set the sort key + * @reimp + */ void setKey( const QString &key ) { m_sortKey = key; } @@ -40,2 +45,6 @@ public: + /** + * foo + * @internal + */ void paint( QPainter *p, const QColorGroup &cg, const QRect &cr, bool selected ); diff --git a/libopie/oclickablelabel.h b/libopie/oclickablelabel.h index 4b6dcbc..6e7a123 100644 --- a/libopie/oclickablelabel.h +++ b/libopie/oclickablelabel.h @@ -34,4 +34,7 @@ public: protected: + /** @internal */ void mousePressEvent( QMouseEvent *e ); + /** @internal */ void mouseReleaseEvent( QMouseEvent *e ); + /** @internal */ void mouseMoveEvent( QMouseEvent *e ); @@ -41,3 +44,11 @@ public: 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); diff --git a/libopie/ocolorbutton.h b/libopie/ocolorbutton.h index 338e654..7ff9cd2 100644 --- a/libopie/ocolorbutton.h +++ b/libopie/ocolorbutton.h @@ -52,2 +52,5 @@ public: signals: + /** + * emitted when a color gets selected + */ void colorSelected ( const QColor & ); @@ -58,2 +61,5 @@ public slots: protected slots: + /** + * @internal + */ virtual void updateColor ( const QColor & ); diff --git a/libopie/odevicebutton.cpp b/libopie/odevicebutton.cpp index 4b22358..eccb57c 100644 --- a/libopie/odevicebutton.cpp +++ b/libopie/odevicebutton.cpp @@ -113,4 +113,4 @@ void OQCopMessage::setData ( const QByteArray &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. diff --git a/libopie/ofileselector.h b/libopie/ofileselector.h index 06ac806..d06aa0a 100644 --- a/libopie/ofileselector.h +++ b/libopie/ofileselector.h @@ -46,9 +46,3 @@ -/** 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; @@ -71,2 +65,11 @@ 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 { diff --git a/libopie/ofontselector.h b/libopie/ofontselector.h index 95ffd04..b819c45 100644 --- a/libopie/ofontselector.h +++ b/libopie/ofontselector.h @@ -75,4 +75,7 @@ signals: protected slots: + /** @internal */ virtual void fontFamilyClicked ( int ); + /** @internal */ virtual void fontStyleClicked ( int ); + /** @internal */ virtual void fontSizeClicked ( int ); diff --git a/libopie/oprocess.h b/libopie/oprocess.h index bf5fe0e..f2853b0 100644 --- a/libopie/oprocess.h +++ b/libopie/oprocess.h @@ -48,3 +48,3 @@ class OProcessPrivate; * - *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. @@ -190,3 +190,9 @@ public: 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); diff --git a/libopie/orecurrancewidget.h b/libopie/orecurrancewidget.h index af87ce9..a5d6489 100644 --- a/libopie/orecurrancewidget.h +++ b/libopie/orecurrancewidget.h @@ -48,3 +48,9 @@ public slots: void slotSetRType( int ); + /** + * set the new end date + */ void endDateChanged( int, int, int ); + /** + * enable/disable end date + */ void slotNoEnd( bool unused ); diff --git a/libopie/otabbar.h b/libopie/otabbar.h index c413611..0b353e2 100644 --- a/libopie/otabbar.h +++ b/libopie/otabbar.h @@ -64,3 +64,3 @@ 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. diff --git a/libopie/otabinfo.h b/libopie/otabinfo.h index 6589638..eebaf8e 100644 --- a/libopie/otabinfo.h +++ b/libopie/otabinfo.h @@ -79,3 +79,3 @@ public: /** - * @fn id() + * @fn id()const * @brief Returns TabBar ID. @@ -85,3 +85,3 @@ public: /** - * @fn label() + * @fn label()const * @brief Returns text label for widget. @@ -99,3 +99,3 @@ public: /** - * @fn control() + * @fn control()const * @brief Returns pointer to widget. @@ -105,3 +105,3 @@ public: /** - * @fn icon() + * @fn icon()const * @brief Returns name of icon file. diff --git a/libopie/otabwidget.h b/libopie/otabwidget.h index bcd9a85..a67fe06 100644 --- a/libopie/otabwidget.h +++ b/libopie/otabwidget.h @@ -129,3 +129,3 @@ public: /** - * @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 @@ -139,3 +139,3 @@ public: /** - * @fn tabStyle() + * @fn tabStyle()const * @brief Returns current widget selection control style. @@ -153,3 +153,3 @@ public: /** - * @fn tabPosition() + * @fn tabPosition()const * @brief Returns current widget selection control position. @@ -191,3 +191,3 @@ public: /** - * @fn sizeHint() + * @fn sizeHint()const * @brief Reimplemented for internal purposes. diff --git a/libopie/oticker.h b/libopie/oticker.h index 30b7517..c848654 100644 --- a/libopie/oticker.h +++ b/libopie/oticker.h @@ -68,3 +68,3 @@ public: /*! - * @fn setText() + * @fn setText(const QString& ) * @brief sets text to be displayed @@ -80,2 +80,3 @@ public: */ + //FIXME const QColor& please -zecke void setBackgroundColor(QColor color); diff --git a/libopie/otimepicker.h b/libopie/otimepicker.h index 495c806..d501a95 100644 --- a/libopie/otimepicker.h +++ b/libopie/otimepicker.h @@ -58,3 +58,3 @@ class OTimePicker: public QWidget { * - * @short + * @short A small dialog to pick a time * @version 1.0 diff --git a/libopie/todayconfigwidget.h b/libopie/todayconfigwidget.h index 6b49efc..f3501a1 100644 --- a/libopie/todayconfigwidget.h +++ b/libopie/todayconfigwidget.h @@ -26,3 +26,3 @@ public: * @param parent The parent of the widget - * @paran name The name of the object + * @param name The name of the object */ diff --git a/libopie/todayplugininterface.h b/libopie/todayplugininterface.h index 29a12bc..532f492 100644 --- a/libopie/todayplugininterface.h +++ b/libopie/todayplugininterface.h @@ -102,2 +102,5 @@ public: struct TodayPluginInterface : public QUnknownInterface { + /** + * return the TodayPluginObject implementation + */ virtual TodayPluginObject *guiPart() = 0; |