Added/Fixed commentation blocks to meed DoD requirements

Reviewed by:

diff --git a/src/situareservice/situareservice.h b/src/situareservice/situareservice.h
index 0906b78..fde915e 100644 (file)
--- a/src/situareservice/situareservice.h
+++ b/src/situareservice/situareservice.h
@@ -50,7 +50,6 @@ public:
     * @brief Default constructor
     *
     * @param parent instance of parent
-    * @param manager instance of QNetworkAccessManager
     */
     SituareService(QObject *parent = 0);
 
@@ -200,7 +199,7 @@ private:
     FacebookCredentials m_credentials; ///< handle for FacebookCredentials
     QList<QNetworkReply *> m_currentRequests; ///< List of current http requests
     QNetworkAccessManager *m_networkManager; ///< Pointer to QNetworkAccessManager
-    ImageFetcher *m_imageFetcher;
+    ImageFetcher *m_imageFetcher; ///< Instance of the image fetcher
 
     User *m_user; ///< Pointer to User
     QList<User *> m_friendsList; ///< List of friends(User)

diff --git a/src/ui/mainwindow.h b/src/ui/mainwindow.h
index b321c9d..0483709 100644 (file)
--- a/src/ui/mainwindow.h
+++ b/src/ui/mainwindow.h
@@ -93,7 +93,7 @@ private:
     /**
     * @brief Method used to switch active view.
     *
-    * @paraDaily scrum 2010-03-26m nextIndex 0 for listview, 1 for mapview
+    * @param nextIndex 0 for listview, 1 for mapview
     */
     void switchView(int);
 
@@ -137,9 +137,9 @@ signals:
  ******************************************************************************/
 
 private:
-    ListViewScreen *m_listViewScreen;
+    ListViewScreen *m_listViewScreen; ///< Instance of the list view
     UpdateLocationDialog *m_locationDialog; ///< Message dialog
-    MapViewScreen *m_mapViewScreen;
+    MapViewScreen *m_mapViewScreen; ///< Instance of the map view
     QStackedWidget *m_situareViews; ///< Stacked widget that hold both view widgets
     QAction *m_toListViewAct; ///< Action to trigger switch to list view
     QAction *m_toMapViewAct; ///< Action to trigger switch to map view

diff --git a/src/ui/updatelocation/texteditautoresizer.h b/src/ui/updatelocation/texteditautoresizer.h
index 47d9dd2..24b71d8 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
-*        become too large.
+* class is used to automatically resize the QTextEdit once the contents
+*     become too large.
+*
+* @class TextEditAutoResizer
 */
 class TextEditAutoResizer : public QObject
 {

diff --git a/src/ui/updatelocation/updatelocationdialog.h b/src/ui/updatelocation/updatelocationdialog.h
index 820bd1c..d584ad7 100755 (executable)
--- a/src/ui/updatelocation/updatelocationdialog.h
+++ b/src/ui/updatelocation/updatelocationdialog.h
@@ -41,7 +41,9 @@ class QTextEdit;
 /**
 * @brief Update Location UI
 *
-* @class UpdateLocationDialog UI for update location functionality.
+* UI for update location functionality.
+*
+* @class UpdateLocationDialog
 */
 class UpdateLocationDialog : public QDialog
 {