Update Runtime document from LB

[platform/framework/native/appfw.git] / inc / FBaseRtWaitingLoop.h

diff --git a/inc/FBaseRtWaitingLoop.h b/inc/FBaseRtWaitingLoop.h
index b8f44a4..06cb7f4 100755 (executable)
--- a/inc/FBaseRtWaitingLoop.h
+++ b/inc/FBaseRtWaitingLoop.h
@@ -33,7 +33,7 @@ namespace Tizen { namespace Base { namespace Runtime
 class IWaitingLoopCondition;
 /*
  * @class WaitingLoop
- * @brief This class allows developers to make the current thread wait for callback events. This class should be used only for test codes and don't use this class for commercial applications
+ * @brief This class allows developers to make the current thread wait for callback events. This class should be used only for test codes and not for commercial applications.
  * @since 2.0
  *
  * @final This class is not intended for extension.
@@ -43,13 +43,14 @@ class _OSP_EXPORT_ WaitingLoop
 {
 public:
        /*
-        * Gets the WaitingLoop instance.
+        * Gets a pointer to the %WaitingLoop instance.
         *
         * @since 2.0
         *
-        * @return      A pointer to the WaitingLoop instance, @n
+        * @return      A pointer to a WaitingLoop instance, @n
         *                              else @c null if it fails   
-        * @remarks Once the WaitingLoop instance has been created, you must not use the instance between threads. Especially, the methods for waiting should be called on the thread you get the instance at first time.
+        * @remarks  Once the WaitingLoop instance has been created, the instance between the threads must not be used. @n
+        *                              Especially, the methods that are waiting should be called on the thread where the instance is obtained for the first time.
         */
        static WaitingLoop* GetInstance(void);
 
@@ -58,13 +59,13 @@ public:
         *
         * @since 2.0
         *
-        * @param[in] timeout   The timeout period in milliseconds  
-        * @exception E_SUCCESS    The method is successful.
-        * @exception E_TIMEOUT    The time is expired.
-        * @exception E_INVALID_STATE    The waiting loop has already been waiting on a callback event. In order to wait again, you must quit the waiting loop.
-        * @remarks The timeout set to min(timeout, maximum), where the maximum is set using SetMaxTimeoutForWaiting().
+        * @param[in] timeout                   The timeout period in milliseconds
+        * @exception E_SUCCESS                 The method is successful.
+        * @exception E_TIMEOUT                 The time has expired.
+        * @exception E_INVALID_STATE   The waiting loop has already been waiting on a callback event. @n
+        *                                                              In order to wait again, quit the waiting loop.
+        * @remarks The timeout is set to min(timeout, maximum), where the maximum is set using SetMaxTimeoutForWaiting().
         * @see Notify()
-        * @see SetMaxTimoutForWaiting()
         */
        result Wait(int timeout);
 
@@ -73,32 +74,35 @@ public:
         *
         * @since 2.0
         *
-        * @param[in] condition The expiring condition  
-         * @exception E_SUCCESS    The method is successful.
-         * @exception E_INVALID_STATE    The waiting loop has already been waiting on a callback event. In order to wait again, you must quit the waiting loop.
-         * @remarks In order to use this method correctly, you have to implement a class inheriting from %IWaitingLoopCondition. 
+        * @param[in] condition                 The expiring condition
+     * @exception E_SUCCESS                    The method is successful.
+     * @exception E_INVALID_STATE   The waiting loop has already been waiting on a callback event. @n
+        *                                                              In order to wait again, quit the waiting loop.
+     * @remarks In order to use this method correctly, you have to implement a class inheriting from IWaitingLoopCondition.
         */
        result Wait(IWaitingLoopCondition& condition);
 
        /*
-        * Starts the waiting loop and waits until either the expiring condition occurs or the time is expired.
+        * Starts the waiting loop and waits until either the expiring condition occurs or the time expires.
         *
         * @since 2.0
         *
-        * @param[in] timeout   The timeout period in milliseconds  
-        * @param[in] condition The expiring condition  
-        * @exception E_TIMEOUT    The time is expired.
-        * @exception E_INVALID_STATE    The waiting loop is waiting on a thread. In order to wait again, you must quit the waiting loop.
-        * @remarks If the timeout is over the maximum, the expired time goes together with the maximum timeout. In order to use this method correctly, you have to implement a class inheriting from %IWaitingLoopCondition interface
+        * @param[in] timeout                   The timeout period in milliseconds
+        * @param[in] condition                 The expiring condition
+        * @exception E_TIMEOUT                 The time has expired.
+        * @exception E_INVALID_STATE   The waiting loop is waiting on a thread. @n
+        *                                                              In order to wait again, quit the waiting loop.
+        * @remarks If the timeout has crossed the maximum value, the expired time goes along with the maximum timeout. @n
+        *                        In order to use this method correctly, implement a class inheriting from the IWaitingLoopCondition interface
         */
        result Wait(int timeout, IWaitingLoopCondition& condition);
 
        /*
-        * Notify the waiting thread that the related callback has completed the job.
+        * Notifies the waiting thread that the related callback has completed the job.
         *
         * @since 2.0
         *
-        * @remarks This method is recommended to use when the waiting condition is not explicitly specified with Wait().
+        * @remarks This method is recommended when the waiting condition is not explicitly specified by Wait().
         */
        void Notify(void);
 
@@ -108,8 +112,8 @@ public:
         * @since 2.0
         *
         * @param[in] timeout    The timeout period in milliseconds
-        *                              else @c false
-        * @remarks If the timeout is considered as a small number, it will be replaced with the specified number provided by platform.
+        *                                              else @c false
+        * @remarks If the timeout is considered as a small number, it is replaced with the specified number provided by the platform.
         */
        static void SetMaxTimeoutForWaiting(int timeout);