Doxygen documentation added

diff --git a/src/IO/DeviceControl/DeviceManager.h b/src/IO/DeviceControl/DeviceManager.h
index 2d0dac4..f4c8ec8 100644 (file)
--- a/src/IO/DeviceControl/DeviceManager.h
+++ b/src/IO/DeviceControl/DeviceManager.h
@@ -106,7 +106,11 @@ signals:
         * \param aAddInfo Possible additional information.
         */
        void error( int aCode, const QString &aAddInfo );
-       
+       //! Signal. Emitted during the operation mode change to explain the current sub-change.
+       /*!
+        * Signal. Emitted during the operation mode change to explain the current sub-change. 
+        * \param aMessage Explains the sub-change
+        */
        void changingMode( const QString &aMessage );
 
 private slots:
@@ -124,7 +128,18 @@ private slots:
         * \param aAddInfo The possible additional error text.
         */
        void errorSender( DeviceManager::ErrorCode aErrorCode, const QString &aAddInfo = "" );
+       //! Slot. Is called after the operation mode changing is finished.
+       /*!
+        * Slot. Is called after the operation mode changing is finished. If everything went fine, restarts
+        * the device. 
+        */
        void modeChanged();
+       //! Slot. Toggles an attribute that indicates whether the errors should be sent.
+       /*!
+        * Slot. Toggles an attribute that indicates whether the errors should be sent.
+        * \param aToggle Indicates if the errors are wanted to be shown.
+        */
+       void toggleErrorSending( bool aToggle );
 
 private:
        //! Updates the internal indicator of the current operation mode.
@@ -149,7 +164,6 @@ private:
         * \param aHandle indicates if the signals should be connected or not.
         */
        void handleKeyPresses( bool aHandle );
-       void toggleErrorSending( bool aToggle );
 
 private:
        AlarmSender *iAlarmSender;

diff --git a/src/IO/DeviceControl/OperationModeToggler.h b/src/IO/DeviceControl/OperationModeToggler.h
index 21413f6..0b22266 100644 (file)
--- a/src/IO/DeviceControl/OperationModeToggler.h
+++ b/src/IO/DeviceControl/OperationModeToggler.h
@@ -34,6 +34,10 @@ public:
         * Run method of the class.
         */
        void run();
+       //! Returns the success status of the operation mode change.
+       /*!
+        * Returns the success status of the operation mode change.
+        */
        bool success();
        //! Stores the current operation mode.
        /*!
@@ -45,8 +49,26 @@ public:
        static bool storeOperationMode( DeviceManager::OperationMode aMode, DeviceDataStorage *aDataStorage );
 
 signals:
+       //! Signal. Emitted if an error occurs during operation mode fetching or reading.
+       /*!
+        * Signal. Emitted if an error occurs during operation mode fetching or reading. Note that other
+        * possible errors are sent by the other instances e.g. alarm sender sents it's own errors. 
+        * \param aCode The error code.
+        */
        void error( DeviceManager::ErrorCode aCode );
+       //! Signal. Emitted if an error occurs during operation mode changing.
+       /*!
+        * Signal. Emitted if an error occurs during operation mode changing. If an error occurs, the operation
+        * mode changes made so far have to be rolled back. During this we don't want to show possible new
+        * errors. 
+        * \param aToggle Indicates if the errors are wanted to be shown.
+        */
        void toggleErrorSending( bool aToggle );
+       //! Signal. Emitted during the operation mode change to explain the current sub-change.
+       /*!
+        * Signal. Emitted during the operation mode change to explain the current sub-change. 
+        * \param aMessage Explains the sub-change
+        */
        void changingMode( const QString &aMessage );
        
 private: