Fixed comments

Reviewed by:

diff --git a/src/map/mapengine.h b/src/map/mapengine.h
index 74e3a4d..15bb3ef 100644 (file)
--- a/src/map/mapengine.h
+++ b/src/map/mapengine.h
@@ -145,7 +145,17 @@ public slots:
     */
     void viewResized(const QSize &size);
 
+    /**
+    * @brief Slot to catch user own location data
+    *
+    * @param user User info
+    */
     void receiveOwnLocation(User *user);
+    /**
+    * @brief Slot to catch friends location data
+    *
+    * @param friendsList QList item of friend information
+    */
     void receiveFriendLocations(QList<User *> &friendsList);
 
 private:

diff --git a/src/ui/friendlistitem.h b/src/ui/friendlistitem.h
index 8019d3a..f5b6536 100644 (file)
--- a/src/ui/friendlistitem.h
+++ b/src/ui/friendlistitem.h
@@ -72,7 +72,7 @@ protected:
     /**
     * @brief Draws stylesheet used in this class.
     *
-    * @param QPaintEvent unused
+    * @param * QPaintEvent unused
     */
     void paintEvent(QPaintEvent *);
 

diff --git a/src/ui/infotab.h b/src/ui/infotab.h
index 126d029..dec7dbd 100644 (file)
--- a/src/ui/infotab.h
+++ b/src/ui/infotab.h
@@ -53,7 +53,7 @@ protected:
     * @param aPaintEvent Pointer to paint event
     */
     void paintEvent(QPaintEvent *aPaintEvent);
-    QSize sizeHint() const;
+    QSize sizeHint() const; ///< Size setting method - OBSOLETE?
 public slots:
     /**
     * @brief Sets the users current address
@@ -120,13 +120,12 @@ private:
     QPixmap m_avatar;         ///< User's avatar
     QWidget *widget;          ///< Parent of all widgets.
     SituareUser *situUser;    ///< Situare user's framed picture
-    QVBoxLayout *verticalLayout;
-    QHBoxLayout *horizontalLayout;
-    QGridLayout *m_layout;
-    QLabel *m_clockLabel;
-    QLabel *m_envelopeLabel;
-    QLabel *m_compassLabel;
-
+    QVBoxLayout *verticalLayout; ///< Vertical layout for personal infotab
+    QHBoxLayout *horizontalLayout; ///< Horizontal layout for personal infotab
+    QGridLayout *m_layout; ///< Grid layout for personal infotab
+    QLabel *m_clockLabel; ///< Text label for clock item
+    QLabel *m_envelopeLabel; ///< Text label for message item
+    QLabel *m_compassLabel; ///< Text label for location item
 };
 
 #endif // INFOTAB_H

diff --git a/src/ui/listviewscreen.h b/src/ui/listviewscreen.h
index 9bc304e..c53dcb5 100644 (file)
--- a/src/ui/listviewscreen.h
+++ b/src/ui/listviewscreen.h
@@ -57,8 +57,18 @@ public:
  * MEMBER FUNCTIONS AND SLOTS
  ******************************************************************************/
 public slots:
+    /**
+    * @brief Slot to capture returning user data from situareService
+    *
+    * @param user
+    */
     void userDataReceived(User *user);
 
+    /**
+    * @brief Slot to capture returningn friends list data from situareService
+    *
+    * @param friendList
+    */
     void friendInfoReceived(QList<User *> &friendList);
 
 signals:
@@ -78,11 +88,11 @@ private:
     InfoTab *m_personalInfo;    ///< Personal info tab
     QVBoxLayout *m_vbox;    ///< Holds the graphics view
     Pixmap *m_arrowbutton;    ///< Button which reveals/hides the info tab when pressed
-    Pixmap *m_leftSideBar;
-    Pixmap *m_slidingLeftSideBar;
-    Pixmap *m_personalInfoBackGround;
-    Pixmap *m_arrowLeft;
-    Pixmap *m_arrowRight;
+    Pixmap *m_leftSideBar; ///< Left side sidebar image
+    Pixmap *m_slidingLeftSideBar; ///< Left side sliding sidebar image
+    Pixmap *m_personalInfoBackGround; ///< Personal info background image
+    Pixmap *m_arrowLeft; ///< Right side arrow image
+    Pixmap *m_arrowRight; ///< Left side arrow image
     QGraphicsProxyWidget *m_widgetProxy; ///< Embeds InfoTab to graphics view
     QAbstractTransition *m_trans1;    ///< Animation transition from hidden state to visible
     QAbstractTransition *m_trans2;    ///< Animation transition from visible to hidden
@@ -92,14 +102,14 @@ private:
     QPropertyAnimation *m_anim4;    ///< Animation for arrowbutton from visible to hidden
     QPropertyAnimation *m_anim5;    ///< Animation
     QPropertyAnimation *m_anim6;    ///< Animation for arrowbutton from visible to hidden
-    QPropertyAnimation *m_anim7;
-    QPropertyAnimation *m_anim8;
-    QPropertyAnimation *m_anim9;
-    QPropertyAnimation *m_anim10;
-    QPropertyAnimation *m_anim11;
-    QPropertyAnimation *m_anim12;
-    QPropertyAnimation *m_anim13;
-    QPropertyAnimation *m_anim14;
+    QPropertyAnimation *m_anim7;    ///< Animation?
+    QPropertyAnimation *m_anim8;    ///< Animation?
+    QPropertyAnimation *m_anim9;    ///< Animation?
+    QPropertyAnimation *m_anim10;    ///< Animation?
+    QPropertyAnimation *m_anim11;    ///< Animation?
+    QPropertyAnimation *m_anim12;    ///< Animation?
+    QPropertyAnimation *m_anim13;    ///< Animation?
+    QPropertyAnimation *m_anim14;    ///< Animation?
     UpdateLocationDialog *m_locationDialog; ///< Message dialog
 
     FriendListView *m_friendListView;   ///< Friend list view

diff --git a/src/ui/mapviewscreen.h b/src/ui/mapviewscreen.h
index b33317e..ccea38b 100644 (file)
--- a/src/ui/mapviewscreen.h
+++ b/src/ui/mapviewscreen.h
@@ -54,7 +54,17 @@ private slots:
     */
     void searchMap();
     
+    /**
+    * @brief Slot to catch signal when user location is fetched
+    *
+    * @param user User data
+    */
     void userLocationReady(User *user);
+    /**
+    * @brief Slot to catch signal when friend list locations are fetched
+    *
+    * @param friendsList Friends list data
+    */
     void friendsLocationsReady(QList<User *> &friendsList);
 
 /*******************************************************************************

diff --git a/src/ui/situareuser.h b/src/ui/situareuser.h
index ade7a0c..c56a9ee 100644 (file)
--- a/src/ui/situareuser.h
+++ b/src/ui/situareuser.h
@@ -25,6 +25,11 @@
 #include <QLabel>
 #include <QPixmap>
 
+/**
+* @brief User class for personal information tab
+*
+* @class SituareUser situareuser.h "ui/situareuser.h"
+*/
 class SituareUser : public QLabel
 {
     Q_OBJECT

diff --git a/src/ui/updatelocation/texteditautoresizer.h b/src/ui/updatelocation/texteditautoresizer.h
index be313bb..1730411 100755 (executable)
--- a/src/ui/updatelocation/texteditautoresizer.h
+++ b/src/ui/updatelocation/texteditautoresizer.h
@@ -30,8 +30,10 @@
 /**
 * @brief TextEditAutoResizer class
 *
-* @class TextEditAutoResizer class is used to automatically resize the QTextEdit once the contents
+* class is used to automatically resize the QTextEdit once the contents
 *        become too large.
+*
+* @class TextEditAutoResizer
 */
 class TextEditAutoResizer : public QObject
 {