From: Mikko Siren <mikko.siren@ixonos.com>
Date: Thu, 28 May 2009 07:27:50 +0000 (+0300)
Subject: Commented the UIManager include file
X-Git-Url: https://vcs.maemo.org/git/?a=commitdiff_plain;h=d54bfd1b1f43bb173a1cd531427216cdd376cc49;hp=bd153701307613c96e7bdf070cf32b0cbc6ae834;p=qtmeetings

Commented the UIManager include file
---

diff --git a/src/BusinessLogic/UIManager.cpp b/src/BusinessLogic/UIManager.cpp
index d6d16b3..2e55db6 100644
--- a/src/BusinessLogic/UIManager.cpp
+++ b/src/BusinessLogic/UIManager.cpp
@@ -37,16 +37,12 @@ UIManager::UIManager( Engine *aEngine, WindowManager *aWindowManager ) :
 	if ( iEngine == 0 ) return;
 	if ( iWindowManager == 0 ) return;
 	
-	qDebug() << "[UIManager::ctor] <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>";
-	
 	createWeeklyView();
 	createSettingsView();
 	createRoomStatusIndicator();
 	createPasswordDialog();
 	createProgressBar();
 	createMeetingInfoDialog();
-	
-	qDebug() << "[UIManager::ctor] <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>";
 }
 
 UIManager::~UIManager()
diff --git a/src/BusinessLogic/UIManager.h b/src/BusinessLogic/UIManager.h
index de123b6..bc0f629 100644
--- a/src/BusinessLogic/UIManager.h
+++ b/src/BusinessLogic/UIManager.h
@@ -18,6 +18,15 @@ class MeetingInfoDialog;
 class CommunicationManager;
 class QDateTime;
 
+//! User Interface manager class.
+/*!
+ * User Interface manager class that is responsible for handling
+ * UI actions. It creates the needed views and connects signals
+ * accordingly. All interactions with the UI is handled by this
+ * class. The Engine class handles the basic logic and does not
+ * know or care about the UI and this class does not know or care
+ * about the basic logic only UI related actions (signals, events etc.).
+ */
 class UIManager : public QObject
 {
 	Q_OBJECT
@@ -26,19 +35,66 @@ public:
 	UIManager( Engine *aEngine, WindowManager *aWindowManager );
 	virtual ~UIManager();
 	
+	//! Connects Device Managers signals.
+	/*!
+	 * This method connects Device Managers signals directly to UI
+	 * components or to it selft.
+	 */
 	void connectDeviceManager( DeviceManager *aDeviceManager );
+	//! Connects Communication Managers signals.
+	/*!
+	 * This method connects Communication Managers signals directly to UI
+	 * components or to it selft.
+	 */
 	void connectCommunicationManager( CommunicationManager *aCommunicationManager );
+	//! Shows the main view.
+	/*!
+	 * Makes the main view visible trough WindowManager.
+	 */
 	void showMainView();
+	//! Shows the progress bar.
+	/*!
+	 * Shows the progress bar with given text.
+	 */
 	void showProgressBar( QString aText );
 
 signals:
 	
 public slots:
 
+	//! Handles setting view request.
+	/*!
+	 * Handles request to show settings view. Makes the
+	 * view visible and stops the idle time counter.
+	 */
 	void settingsViewRequest();
+	//! Handles setting views ok clicked.
+	/*!
+	 * Handles the setting views Ok button clicked
+	 * signal. Sets the weekly view visible and starts
+	 * the idle time counter.
+	 */
 	void settingsOkClicked();
+	//! Handles room status indicator view request.
+	/*!
+	 * Handles the request to show room status indicator
+	 * view. Sets the view visible and stops the idle
+	 * time counter. The WindowManager handles restoring
+	 * what ever view was previously visible.
+	 */
 	void roomStatusIndicatorRequested();
+	//! Handles previousViewRestored signal.
+	/*!
+	 * Handles the restoring of previous view. This is usually
+	 * signaled by WindowManager when room status indicator
+	 * view is being hidden.
+	 */
 	void previousViewRestored();
+	//! Handle change mode order.
+	/*!
+	 * Handles change mode order. Displays the password query dialog
+	 * and waits for its response.
+	 */
 	void changeModeOrdered( DeviceManager::OperationMode aMode );
 	
 private slots: