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

1 files changed, 11 insertions, 0 deletions

diff --git a/libopie/oclickablelabel.h b/libopie/oclickablelabel.h
index 4b6dcbc..6e7a123 100644
--- a/libopie/oclickablelabel.h
+++ b/libopie/oclickablelabel.h
@@ -1,53 +1,64 @@
 #ifndef CLICKABLELABEL
 #define CLICKABLELABEL
 
 #include <qlabel.h>
 
 /**
  * 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
 {
   Q_OBJECT
 public:
     OClickableLabel(QWidget* parent = 0, const char* name = 0,
 		   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;
     bool textInverted : 1;
 
     void showState(bool on);
     void setInverted(bool on);
 };
 
 #endif