comment fixes
authorsheepluva
Fri, 21 Oct 2011 01:36:13 +0200
changeset 6162 437116977d43
parent 6161 98486efeb0b7
child 6163 fcb709d55413
comment fixes
QTfrontend/ui/widget/HistoryLineEdit.h
QTfrontend/ui/widget/SmartLineEdit.h
QTfrontend/util/HWDataManager.h
--- a/QTfrontend/ui/widget/HistoryLineEdit.h	Fri Oct 21 00:02:11 2011 +0200
+++ b/QTfrontend/ui/widget/HistoryLineEdit.h	Fri Oct 21 01:36:13 2011 +0200
@@ -81,12 +81,12 @@
 
 
 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
 
     /**
      * @brief Navigates content history in the desired direction.
--- a/QTfrontend/ui/widget/SmartLineEdit.h	Fri Oct 21 00:02:11 2011 +0200
+++ b/QTfrontend/ui/widget/SmartLineEdit.h	Fri Oct 21 01:36:13 2011 +0200
@@ -29,7 +29,7 @@
 
 /**
  * @brief A {@link HistoryLineEdit} that features auto-completion with TAB key
-*         and clear with ESC key.
+ *         and clear with ESC key.
  *
  * Notes:
  * <ul>
@@ -107,30 +107,30 @@
 
 
 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.
+     * @brief Autocompletes the contents based on the known commands and/or names.
      */
     void autoComplete();
 
 
 private slots:
     /**
-     * Resets the information about the last match and text replacement.
+     * @brief Resets the information about the last match and text replacement.
      */
     void resetAutoCompletionStatus();
 };
--- a/QTfrontend/util/HWDataManager.h	Fri Oct 21 00:02:11 2011 +0200
+++ b/QTfrontend/util/HWDataManager.h	Fri Oct 21 01:36:13 2011 +0200
@@ -97,8 +97,8 @@
      */
     HWDataManager();
 
-    QDir * defaultData;
-    QDir * userData;
+    QDir * defaultData; ///< directory of the installed data
+    QDir * userData;    ///< directory of custom data in the user's directory
 };
 
 #endif // HEDGEWARS_HWDATAMANAGER_H