Implemented List and Map views as widget stack. Views filled with

[situare] / src / ui / mainwindow.h

diff --git a/src/ui/mainwindow.h b/src/ui/mainwindow.h
index 46f6997..ae4a600 100644 (file)
--- a/src/ui/mainwindow.h
+++ b/src/ui/mainwindow.h
@@ -31,6 +31,11 @@ class QAction;
 class QStackedWidget;
 class QLabel;
 
+/**
+* @Main Window Class
+*
+* @class MainWindow mainwindow.h "src/ui/mainwindow.h"
+*/
 class MainWindow : public QMainWindow
 {
     Q_OBJECT
@@ -40,27 +45,78 @@ public:
     ~MainWindow();
 
 private:
+    /**
+    * @brief Private method to create the Menu items
+    *
+    * @fn createMenus
+    */
     void createMenus();
+    /**
+    * @brief Private method to create List and Map views as a stacked widget
+    *
+    * @fn createViews
+    */
     void createViews();
 
     QMenu *viewMenu;
+    /**
+    * @brief Action item for changing view to List View
+    *
+    * @var toListViewAct
+    */
     QAction *toListViewAct;
+    /**
+    * @brief Action item for changing view to Map View
+    *
+    * @var toMapViewAct
+    */
     QAction *toMapViewAct;
+    /**
+    * @brief Widget Stack object for the List and Map Views
+    *
+    * @var situareViews
+    */
     QStackedWidget *situareViews;
 
+    /**
+    * @brief DUMMY LABEL, REMOVE WHEN BOTH VIEWS ARE COMPLETE
+    *
+    * @var infoLabel
+    * @todo REMOVE THIS
+    */
     QLabel *infoLabel;
 
 private slots:
+    /**
+    * @brief Private slot, which initiates toListViewAct action
+    *
+    * @fn toListView
+    */
     void toListView();
+    /**
+    * @brief Private slots, which initiates toMapViewAct action
+    *
+    * @fn toMapView
+    */
     void toMapView();
 };
 
+/**
+* @brief List View class. Used for displaying List of friends
+*
+* @class SituareListView mainwindow.h "src/ui/mainwindow.h"
+*/
 class SituareListView : public QWidget
 {
 public:
     SituareListView(QWidget *parent = 0);
 };
 
+/**
+* @brief Map View class. Used to display Map
+*
+* @class SituareMapView mainwindow.h "src/ui/mainwindow.h"
+*/
 class SituareMapView : public QWidget
 {
 public: