# HG changeset patch
# User sheepluva
# Date 1319148131 -7200
# Node ID 98486efeb0b709b8f04add3845a11140299902e3
# Parent  863d3edf56906ce33948145474bb127061909279
comments

diff -r 863d3edf5690 -r 98486efeb0b7 QTfrontend/ui/widget/HistoryLineEdit.h
--- a/QTfrontend/ui/widget/HistoryLineEdit.h	Thu Oct 20 23:25:16 2011 +0200
+++ b/QTfrontend/ui/widget/HistoryLineEdit.h	Fri Oct 21 00:02:11 2011 +0200
@@ -44,58 +44,62 @@
 
 public:
     /**
-    * Class constructor.
+    * @brief Class constructor.
     * @param parent parent QWidget.
     * @param maxHistorySize maximum amount of history entries kept.
     */
     HistoryLineEdit(QWidget * parent = 0, int maxHistorySize = 64);
 
     /**
-     * Appends current text to history (if not only whitespaces);
+     * @brief Appends current text to history (if not only whitespaces);
      */
     void rememberCurrentText();
 
     /**
-     * Forget all history.
+     * @brief Forget all history.
      */
     void reset();
 
 
 public slots:
     /**
-     * Clears the contents.
+     * @brief Clears the contents.
      */
     void clear();
 
 
 protected:
     /**
-     * Overrides method of parent class.
+     * @brief Overrides method of parent class.
      * Arrow keys are used for navigating the history.
+     *
      * All other keys are forwarded to the parent's method.
+     * 
      * @param event the key event.
      */
     virtual void keyPressEvent(QKeyEvent * event);
 
 
 private:
-    int m_maxHistorySize; // the maximum allowed size for the history
-    int m_curHistEntryIdx; // the index of the displayed used entry
+    int m_maxHistorySize; /// the maximum allowed size for the history
+    int m_curHistEntryIdx; /// the index of the displayed used entry
 
-    QStringList * m_history; // history of previous inputs
+    QStringList * m_history; /// history of previous inputs
 
-    QMutex m_historyMutex; // make history QStringList action thread-safe
+    QMutex m_historyMutex; /// make history QStringList action thread-safe
 
     /**
-     * Navigates content history in the desired direction.
+     * @brief Navigates content history in the desired direction.
+     *
      * Note: no wrap-around on purpose (so that holding down/up will get the
      * the user to the respective end rather than into an endless cycle :P)
+     * 
      * @param isGoingUp true: next older entry, false: next more recent entry.
      */
     void navigateHistory(bool isGoingUp);
 
     /**
-     * Appends current text to history, without Mutex.
+     * @brief Appends current text to history, without Mutex.
      */
     void rememberCurrentTextUnsynced();
 };
diff -r 863d3edf5690 -r 98486efeb0b7 QTfrontend/ui/widget/SmartLineEdit.h
--- a/QTfrontend/ui/widget/SmartLineEdit.h	Thu Oct 20 23:25:16 2011 +0200
+++ b/QTfrontend/ui/widget/SmartLineEdit.h	Fri Oct 21 00:02:11 2011 +0200
@@ -47,77 +47,80 @@
 
 public:
     /**
-    * Class constructor.
+    * @brief Class constructor.
     * @param parent parent QWidget.
     * @param maxHistorySize maximum amount of history entries kept.
     */
     SmartLineEdit(QWidget * parent = 0, int maxHistorySize = 64);
 
     /**
-     * Adds commands to the auto-completion feature.
+     * @brief Adds commands to the auto-completion feature.
      * @param commands list of commands to be added.
      */
     void addCommands(const QStringList & commands);
 
     /**
-     * Adds a single nickname to the auto-completion feature.
+     * @brief Adds a single nickname to the auto-completion feature.
      * @param nickname name to be added.
      */
     void addNickname(const QString & nickname);
 
     /**
-     * Removes commands from the auto-completion feature.
+     * @brief Removes commands from the auto-completion feature.
      * @param commands list of commands to be removed.
      */
     void removeCommands(const QStringList & commands);
 
     /**
-     * Removes a single nickname from the auto-completion feature.
+     * @brief Removes a single nickname from the auto-completion feature.
      * @param nickname name to be removed.
      */
     void removeNickname(const QString & nickname);
 
     /**
-     * Forget all keywords and input history.
+     * @brief Forget all keywords and input history.
      */
     void reset();
 
 
 protected:
     /**
-     * Overrides method of parent class.
+     * @brief Overrides method of parent class.
      * Forward pressed TAB to parent class' method (for focus handling etc)
      * only if line is empty.
+     * 
      * @param event the key event.
      * @return returns true if the event was recognized.
      */
     virtual bool event(QEvent * event);
 
     /**
-     * Overrides method of parent class.
+     * @brief Overrides method of parent class.
      * Autocompletes if TAB is reported as pressed key in the key event,
      * ESC leads to the contents being cleared.
-     * otherwise keys are forwarded to parent method.
+     * 
+     * Other keys are forwarded to parent method.
+     *
      * @param event the key event.
      */
     virtual void keyPressEvent(QKeyEvent * event);
 
 
 private:
-    QRegExp m_whitespace; // regexp that matches a whitespace
+    QRegExp m_whitespace; /// regexp that matches a whitespace
 
-    QStringList * m_cmds;  // list of recognized commands
-    QStringList * m_nicks; // list of recognized nicknames
+    QStringList * m_cmds;  /// list of recognized commands
+    QStringList * m_nicks; /// list of recognized nicknames
 
     // these variables contain information about the last replacement
     // they get reset whenever cursor is moved or text is changed
 
-    QString m_beforeMatch; // the string that was just matched
-    bool m_hasJustMatched; // whether this widget just did an auto-completion
-    QString m_prefix; // prefix of the text replacement this widget just did
-    QString m_postfix; // postfix of the text replacement this widget just did
+    QString m_beforeMatch; /// the string that was just matched
+    bool m_hasJustMatched; /// whether this widget just did an auto-completion
+    QString m_prefix; /// prefix of the text replacement this widget just did
+    QString m_postfix; /// postfix of the text replacement this widget just did
 
-    QMutex m_keywordMutex; // make keyword QStringList action thread-safe
+    QMutex m_keywordMutex; /// make keyword QStringList action thread-safe
 
     /**
      * Autocompletes the contents based on the known commands and/or names.