author | zecke <zecke> | 2003-04-16 10:59:24 (UTC) |
---|---|---|
committer | zecke <zecke> | 2003-04-16 10:59:24 (UTC) |
commit | 5b9d1ddde859ff783f95babf1887fa40e6bfe0be (patch) (unidiff) | |
tree | 0a8596c4de5145e5f469a6c0d8dbd2f946ef0817 | |
parent | eeb29547890a2d162de66d7d5b98d3840a7e2d79 (diff) | |
download | opie-5b9d1ddde859ff783f95babf1887fa40e6bfe0be.zip opie-5b9d1ddde859ff783f95babf1887fa40e6bfe0be.tar.gz opie-5b9d1ddde859ff783f95babf1887fa40e6bfe0be.tar.bz2 |
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
-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 | |||
@@ -693,5 +693,5 @@ OColorDialogPrivate::OColorDialogPrivate( OColorDialog *dialog ) : | |||
693 | // BEING REVISED: jo | 693 | // BEING REVISED: jo |
694 | /*! | 694 | /*! |
695 | \class OColorDialog OColorDialog.h | 695 | \class ColorDialog ColorDialog.h |
696 | \brief The OColorDialog class provides a dialog widget for specifying colors. | 696 | \brief The OColorDialog class provides a dialog widget for specifying colors. |
697 | \ingroup dialogs | 697 | \ingroup dialogs |
diff --git a/libopie/colordialog.h b/libopie/colordialog.h index e9bb7ed..1a6a3fd 100644 --- a/libopie/colordialog.h +++ b/libopie/colordialog.h | |||
@@ -45,5 +45,5 @@ | |||
45 | class OColorDialogPrivate; | 45 | class OColorDialogPrivate; |
46 | 46 | ||
47 | /** | 47 | /* |
48 | * @class OColorDialog | 48 | * @class OColorDialog |
49 | * @brief The OColorDialog class is a copy of QColorDialog for use in Opie. | 49 | * @brief The OColorDialog class is a copy of QColorDialog for use in Opie. |
diff --git a/libopie/colorpopupmenu.h b/libopie/colorpopupmenu.h index 184b132..3e90c5e 100644 --- a/libopie/colorpopupmenu.h +++ b/libopie/colorpopupmenu.h | |||
@@ -69,5 +69,5 @@ public: | |||
69 | 69 | ||
70 | /** | 70 | /** |
71 | * @fn ~ColorPanelButton() | 71 | * @fn ~OColorPanelButton() |
72 | * @brief Object destructor. | 72 | * @brief Object destructor. |
73 | */ | 73 | */ |
@@ -108,9 +108,9 @@ public: | |||
108 | 108 | ||
109 | /** | 109 | /** |
110 | * @fn paintEvent( QEvent* e ) | 110 | * @fn paintEvent( QPaintEvent* e ) |
111 | * @brief Reimplemented for internal reasons. | 111 | * @brief Reimplemented for internal reasons. |
112 | * | 112 | * |
113 | * @param e Event currently being processed. | 113 | * @param e Event currently being processed. |
114 | * | 114 | * @reimp |
115 | * Reimplemented to ensure correct display of button. | 115 | * Reimplemented to ensure correct display of button. |
116 | */ | 116 | */ |
diff --git a/libopie/ocheckitem.h b/libopie/ocheckitem.h index 2387134..82ee3d0 100644 --- a/libopie/ocheckitem.h +++ b/libopie/ocheckitem.h | |||
@@ -30,4 +30,5 @@ class OCheckItem : public QTableItem | |||
30 | { | 30 | { |
31 | public: | 31 | public: |
32 | /** The size of a box currently unused */ | ||
32 | enum Size { BoxSize = 10 }; | 33 | enum Size { BoxSize = 10 }; |
33 | OCheckItem( QTable *t, const QString &sortkey ); | 34 | OCheckItem( QTable *t, const QString &sortkey ); |
@@ -36,7 +37,15 @@ public: | |||
36 | virtual void toggle(); | 37 | virtual void toggle(); |
37 | bool isChecked() const; | 38 | bool isChecked() const; |
39 | /** | ||
40 | * @short Set the sort key | ||
41 | * @reimp | ||
42 | */ | ||
38 | void setKey( const QString &key ) { m_sortKey = key; } | 43 | void setKey( const QString &key ) { m_sortKey = key; } |
39 | virtual QString key() const; | 44 | virtual QString key() const; |
40 | 45 | ||
46 | /** | ||
47 | * foo | ||
48 | * @internal | ||
49 | */ | ||
41 | void paint( QPainter *p, const QColorGroup &cg, const QRect &cr, bool selected ); | 50 | void paint( QPainter *p, const QColorGroup &cg, const QRect &cr, bool selected ); |
42 | 51 | ||
diff --git a/libopie/oclickablelabel.h b/libopie/oclickablelabel.h index 4b6dcbc..6e7a123 100644 --- a/libopie/oclickablelabel.h +++ b/libopie/oclickablelabel.h | |||
@@ -33,6 +33,9 @@ public: | |||
33 | 33 | ||
34 | protected: | 34 | protected: |
35 | /** @internal */ | ||
35 | void mousePressEvent( QMouseEvent *e ); | 36 | void mousePressEvent( QMouseEvent *e ); |
37 | /** @internal */ | ||
36 | void mouseReleaseEvent( QMouseEvent *e ); | 38 | void mouseReleaseEvent( QMouseEvent *e ); |
39 | /** @internal */ | ||
37 | void mouseMoveEvent( QMouseEvent *e ); | 40 | void mouseMoveEvent( QMouseEvent *e ); |
38 | 41 | ||
@@ -40,5 +43,13 @@ public: | |||
40 | void setOn(bool on); | 43 | void setOn(bool on); |
41 | signals: | 44 | signals: |
45 | /** | ||
46 | * emitted when the labels gets clicked | ||
47 | */ | ||
42 | void clicked(); | 48 | void clicked(); |
49 | |||
50 | /** | ||
51 | * emitted when the labels gets toggled | ||
52 | * @param the new new state of the label | ||
53 | */ | ||
43 | void toggled(bool on); | 54 | void toggled(bool on); |
44 | private: | 55 | private: |
diff --git a/libopie/ocolorbutton.h b/libopie/ocolorbutton.h index 338e654..7ff9cd2 100644 --- a/libopie/ocolorbutton.h +++ b/libopie/ocolorbutton.h | |||
@@ -51,4 +51,7 @@ public: | |||
51 | 51 | ||
52 | signals: | 52 | signals: |
53 | /** | ||
54 | * emitted when a color gets selected | ||
55 | */ | ||
53 | void colorSelected ( const QColor & ); | 56 | void colorSelected ( const QColor & ); |
54 | 57 | ||
@@ -57,4 +60,7 @@ public slots: | |||
57 | 60 | ||
58 | protected slots: | 61 | protected slots: |
62 | /** | ||
63 | * @internal | ||
64 | */ | ||
59 | virtual void updateColor ( const QColor & ); | 65 | virtual void updateColor ( const QColor & ); |
60 | 66 | ||
diff --git a/libopie/odevicebutton.cpp b/libopie/odevicebutton.cpp index 4b22358..eccb57c 100644 --- a/libopie/odevicebutton.cpp +++ b/libopie/odevicebutton.cpp | |||
@@ -112,6 +112,6 @@ void OQCopMessage::setData ( const QByteArray &data ) | |||
112 | } | 112 | } |
113 | 113 | ||
114 | /*! \class ODeviceButton | 114 | /*! \class Opie::ODeviceButton |
115 | \brief The ODeviceButton class represents a physical user mappable button on a Qtopia device. | 115 | \brief The Opie::ODeviceButton class represents a physical user mappable button on a Qtopia device. |
116 | 116 | ||
117 | This class represents a physical button on a Qtopia device. A | 117 | This class represents a physical button on a Qtopia device. A |
diff --git a/libopie/ofileselector.h b/libopie/ofileselector.h index 06ac806..d06aa0a 100644 --- a/libopie/ofileselector.h +++ b/libopie/ofileselector.h | |||
@@ -45,11 +45,5 @@ | |||
45 | #include <qlistview.h> | 45 | #include <qlistview.h> |
46 | 46 | ||
47 | /** This is OPIEs FileDialog Widget. You can use it | 47 | |
48 | * as a dropin replacement of the fileselector and | ||
49 | * or use any of the new features. | ||
50 | * This is also a complete FileSave and FileLoad widget | ||
51 | * If you look for a Dialog check OFileDialog | ||
52 | * | ||
53 | */ | ||
54 | class DocLnk; | 48 | class DocLnk; |
55 | class QCheckBox; | 49 | class QCheckBox; |
@@ -70,4 +64,13 @@ class QHBox; | |||
70 | typedef QMap< QString, QStringList> MimeTypes; | 64 | typedef QMap< QString, QStringList> MimeTypes; |
71 | 65 | ||
66 | /** | ||
67 | * This is OPIEs FileDialog Widget. You can use it | ||
68 | * as a dropin replacement of the fileselector and | ||
69 | * or use any of the new features. | ||
70 | * This is also a complete FileSave and FileLoad widget | ||
71 | * If you look for a Dialog check OFileDialog | ||
72 | * | ||
73 | * NOTE THAT the API will change to be more extendable! | ||
74 | */ | ||
72 | class OFileSelector : public QWidget { | 75 | class OFileSelector : public QWidget { |
73 | Q_OBJECT | 76 | Q_OBJECT |
diff --git a/libopie/ofontselector.h b/libopie/ofontselector.h index 95ffd04..b819c45 100644 --- a/libopie/ofontselector.h +++ b/libopie/ofontselector.h | |||
@@ -74,6 +74,9 @@ signals: | |||
74 | 74 | ||
75 | protected slots: | 75 | protected slots: |
76 | /** @internal */ | ||
76 | virtual void fontFamilyClicked ( int ); | 77 | virtual void fontFamilyClicked ( int ); |
78 | /** @internal */ | ||
77 | virtual void fontStyleClicked ( int ); | 79 | virtual void fontStyleClicked ( int ); |
80 | /** @internal */ | ||
78 | virtual void fontSizeClicked ( int ); | 81 | virtual void fontSizeClicked ( int ); |
79 | 82 | ||
diff --git a/libopie/oprocess.h b/libopie/oprocess.h index bf5fe0e..f2853b0 100644 --- a/libopie/oprocess.h +++ b/libopie/oprocess.h | |||
@@ -47,5 +47,5 @@ class OProcessPrivate; | |||
47 | * @sect General usage and features | 47 | * @sect General usage and features |
48 | * | 48 | * |
49 | *This class allows a KDE application to start child processes without having | 49 | *This class allows a KDE and OPIE application to start child processes without having |
50 | *to worry about UN*X signal handling issues and zombie process reaping. | 50 | *to worry about UN*X signal handling issues and zombie process reaping. |
51 | * | 51 | * |
@@ -189,5 +189,11 @@ public: | |||
189 | */ | 189 | */ |
190 | OProcess(QObject *parent = 0, const char *name = 0); | 190 | OProcess(QObject *parent = 0, const char *name = 0); |
191 | /** | ||
192 | * Constructor | ||
193 | */ | ||
191 | OProcess(const QString &arg0, QObject *parent = 0, const char *name = 0); | 194 | OProcess(const QString &arg0, QObject *parent = 0, const char *name = 0); |
195 | /** | ||
196 | * Constructor | ||
197 | */ | ||
192 | OProcess(const QStringList &args, QObject *parent = 0, const char *name = 0); | 198 | OProcess(const QStringList &args, QObject *parent = 0, const char *name = 0); |
193 | 199 | ||
diff --git a/libopie/orecurrancewidget.h b/libopie/orecurrancewidget.h index af87ce9..a5d6489 100644 --- a/libopie/orecurrancewidget.h +++ b/libopie/orecurrancewidget.h | |||
@@ -47,5 +47,11 @@ public: | |||
47 | public slots: | 47 | public slots: |
48 | void slotSetRType( int ); | 48 | void slotSetRType( int ); |
49 | /** | ||
50 | * set the new end date | ||
51 | */ | ||
49 | void endDateChanged( int, int, int ); | 52 | void endDateChanged( int, int, int ); |
53 | /** | ||
54 | * enable/disable end date | ||
55 | */ | ||
50 | void slotNoEnd( bool unused ); | 56 | void slotNoEnd( bool unused ); |
51 | void setStartDate( const QDate& ); | 57 | void setStartDate( const QDate& ); |
diff --git a/libopie/otabbar.h b/libopie/otabbar.h index c413611..0b353e2 100644 --- a/libopie/otabbar.h +++ b/libopie/otabbar.h | |||
@@ -63,5 +63,5 @@ public: | |||
63 | protected: | 63 | protected: |
64 | /** | 64 | /** |
65 | * @fn paintLabel( QPainter* p, const QRect& br, QTab* t, bool has_focus ) | 65 | * @fn paintLabel( QPainter* p, const QRect& br , QTab* t, bool has_focus)const |
66 | * @brief Internal function to draw a tab's label. | 66 | * @brief Internal function to draw a tab's label. |
67 | * | 67 | * |
diff --git a/libopie/otabinfo.h b/libopie/otabinfo.h index 6589638..eebaf8e 100644 --- a/libopie/otabinfo.h +++ b/libopie/otabinfo.h | |||
@@ -78,5 +78,5 @@ public: | |||
78 | 78 | ||
79 | /** | 79 | /** |
80 | * @fn id() | 80 | * @fn id()const |
81 | * @brief Returns TabBar ID. | 81 | * @brief Returns TabBar ID. |
82 | */ | 82 | */ |
@@ -84,5 +84,5 @@ public: | |||
84 | 84 | ||
85 | /** | 85 | /** |
86 | * @fn label() | 86 | * @fn label()const |
87 | * @brief Returns text label for widget. | 87 | * @brief Returns text label for widget. |
88 | */ | 88 | */ |
@@ -98,5 +98,5 @@ public: | |||
98 | 98 | ||
99 | /** | 99 | /** |
100 | * @fn control() | 100 | * @fn control()const |
101 | * @brief Returns pointer to widget. | 101 | * @brief Returns pointer to widget. |
102 | */ | 102 | */ |
@@ -104,5 +104,5 @@ public: | |||
104 | 104 | ||
105 | /** | 105 | /** |
106 | * @fn icon() | 106 | * @fn icon()const |
107 | * @brief Returns name of icon file. | 107 | * @brief Returns name of icon file. |
108 | */ | 108 | */ |
diff --git a/libopie/otabwidget.h b/libopie/otabwidget.h index bcd9a85..a67fe06 100644 --- a/libopie/otabwidget.h +++ b/libopie/otabwidget.h | |||
@@ -128,5 +128,5 @@ public: | |||
128 | 128 | ||
129 | /** | 129 | /** |
130 | * @fn changeTab( QWidget *widget, const QIconSet &icon, const QString &label ) | 130 | * @fn changeTab( QWidget *widget, const QString &icon, const QString &label ) |
131 | * @brief Change text and/or icon for existing tab | 131 | * @brief Change text and/or icon for existing tab |
132 | * | 132 | * |
@@ -138,5 +138,5 @@ public: | |||
138 | 138 | ||
139 | /** | 139 | /** |
140 | * @fn tabStyle() | 140 | * @fn tabStyle()const |
141 | * @brief Returns current widget selection control style. | 141 | * @brief Returns current widget selection control style. |
142 | */ | 142 | */ |
@@ -152,5 +152,5 @@ public: | |||
152 | 152 | ||
153 | /** | 153 | /** |
154 | * @fn tabPosition() | 154 | * @fn tabPosition()const |
155 | * @brief Returns current widget selection control position. | 155 | * @brief Returns current widget selection control position. |
156 | */ | 156 | */ |
@@ -190,5 +190,5 @@ public: | |||
190 | 190 | ||
191 | /** | 191 | /** |
192 | * @fn sizeHint() | 192 | * @fn sizeHint()const |
193 | * @brief Reimplemented for internal purposes. | 193 | * @brief Reimplemented for internal purposes. |
194 | */ | 194 | */ |
diff --git a/libopie/oticker.h b/libopie/oticker.h index 30b7517..c848654 100644 --- a/libopie/oticker.h +++ b/libopie/oticker.h | |||
@@ -67,5 +67,5 @@ public: | |||
67 | ~OTicker(); | 67 | ~OTicker(); |
68 | /*! | 68 | /*! |
69 | * @fn setText() | 69 | * @fn setText(const QString& ) |
70 | * @brief sets text to be displayed | 70 | * @brief sets text to be displayed |
71 | * @param text QString text to be displayed. | 71 | * @param text QString text to be displayed. |
@@ -79,4 +79,5 @@ public: | |||
79 | * | 79 | * |
80 | */ | 80 | */ |
81 | //FIXME const QColor& please -zecke | ||
81 | void setBackgroundColor(QColor color); | 82 | void setBackgroundColor(QColor color); |
82 | /*! | 83 | /*! |
diff --git a/libopie/otimepicker.h b/libopie/otimepicker.h index 495c806..d501a95 100644 --- a/libopie/otimepicker.h +++ b/libopie/otimepicker.h | |||
@@ -57,5 +57,5 @@ class OTimePicker: public QWidget { | |||
57 | /** | 57 | /** |
58 | * | 58 | * |
59 | * @short | 59 | * @short A small dialog to pick a time |
60 | * @version 1.0 | 60 | * @version 1.0 |
61 | * @author Stefan Eilers | 61 | * @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 | |||
@@ -25,5 +25,5 @@ public: | |||
25 | * | 25 | * |
26 | * @param parent The parent of the widget | 26 | * @param parent The parent of the widget |
27 | * @paran name The name of the object | 27 | * @param name The name of the object |
28 | */ | 28 | */ |
29 | TodayConfigWidget( QWidget *parent, const char *name ) : QWidget( parent, name ) {} ; | 29 | TodayConfigWidget( QWidget *parent, const char *name ) : QWidget( parent, name ) {} ; |
diff --git a/libopie/todayplugininterface.h b/libopie/todayplugininterface.h index 29a12bc..532f492 100644 --- a/libopie/todayplugininterface.h +++ b/libopie/todayplugininterface.h | |||
@@ -101,4 +101,7 @@ public: | |||
101 | */ | 101 | */ |
102 | struct TodayPluginInterface : public QUnknownInterface { | 102 | struct TodayPluginInterface : public QUnknownInterface { |
103 | /** | ||
104 | * return the TodayPluginObject implementation | ||
105 | */ | ||
103 | virtual TodayPluginObject *guiPart() = 0; | 106 | virtual TodayPluginObject *guiPart() = 0; |
104 | }; | 107 | }; |