Fixed comments
authorMateusz Półrola <mateusz.polrola@comarch.pl>
Wed, 1 Sep 2010 13:15:07 +0000 (15:15 +0200)
committerMateusz Półrola <mateusz.polrola@comarch.pl>
Wed, 1 Sep 2010 13:15:07 +0000 (15:15 +0200)
trunk/src/base/gui/SearchBarWidget.h

index 25eed8b..1972053 100644 (file)
@@ -60,6 +60,10 @@ Q_SIGNALS:
     void historyNext();
 
     //! Requests to show history list
+    /*!
+      \param p this argument is used only on desktop, it defines place on
+      which popup with history will be shown
+    */
     void historyShow(QPoint p = QPoint(-1,-1));
 
     //! Requests to refresh state of history buttons
@@ -77,37 +81,49 @@ public Q_SLOTS:
     //! Sets search bar in busy state
     /*!
       Displays "busy" bar and disables search word text edit and history buttons
-      */
+    */
     void setBusy();
 
     //! Sets search bar in idle state
     /*!
       Hides "busy" bar and enables all widgets, refreshes state of history buttons
       by emitting refreshHistoryButtons signal
-      */
+    */
     void setIdle();
 
     //! Searches for given word
     /*!
       Sets word as text in search word line edit
-      */
+    */
     void search(QString word);
 
-    //! Starts to search for given word after 500 ms
+    //! Starts to search for given word after 500 ms delay
     /*!
       Sets word as text in search word line edit, and waits 500 ms to start
       search. If in meanwhile this slot is called again it will stop previous
       timers.
-      */
+    */
     void searchDelay(QString word);
 
     //! Updates state of history buttons
+    /*!
+      \param prev if set to true, the history have some previous words
+      \param next if set to true, the history have some next words
+      \param list if set to true, the history can show word list
+    */
     void updateHistoryButtons(bool prev, bool next, bool list);
 
 private Q_SLOTS:
+    //! Clears search word line edit
     void clearSearchWordToolButtonClicked();
+
+    //! Starts to search for given words
     void searchPushButtonClicked();
+
+    //! starts to search word wich was passed to searchDelay
     void delaySearchTimeout();
+
+    //! shows history
     void showHistoryButtonClicked();
 
 
@@ -124,6 +140,8 @@ private:
     QHBoxLayout* horizontalLayout;
     QProgressBar* searchingProgressBar;
 
+
+    //! generates icon for maemo
     QIcon generateIcon(QIcon oryginal, qreal rotation=0);
 
     QVBoxLayout* verticalLayout;