Enable build with iniparser v 3.1
[platform/framework/native/appfw.git] / inc / FBaseRtEventDrivenThread.h
index 0f04666..a26f9e5 100644 (file)
@@ -35,7 +35,7 @@ namespace Tizen { namespace Base { namespace Runtime
 
 /**
  * @class   EventDrivenThread
- * @brief              This class is the fundamental class for the asynchronous execution of a thread.
+ * @brief      This class is the fundamental class for the asynchronous execution of a thread.
  *
  * @since 2.0
  *
@@ -151,7 +151,7 @@ public:
         * @param[in]   stackSize       The thread stack size
         * @param[in]   priority        The thread priority
         * @exception   E_SUCCESS       The method is successful.
-        * @exception   E_INVALID_ARG   An invalid argument is passed.
+        * @exception   E_INVALID_ARG   A specified input parameter is invalid.
         * @exception   E_OUT_OF_MEMORY The memory is insufficient.
         */
        result Construct(long stackSize = DEFAULT_STACK_SIZE, ThreadPriority priority = THREAD_PRIORITY_MID);
@@ -162,11 +162,11 @@ public:
         * @since 2.0
         *
         * @return      An error code
-        * @param[in]   name                    The name of the thread
+        * @param[in]   name            The name of the thread
         * @param[in]   stackSize       The thread stack size
         * @param[in]   priority        The thread priority
         * @exception   E_SUCCESS       The method is successful.
-        * @exception   E_INVALID_ARG   An invalid argument is passed.
+        * @exception   E_INVALID_ARG    A specified input parameter is invalid.
         * @exception   E_OUT_OF_MEMORY The memory is insufficient.
         */
        result Construct(const Tizen::Base::String& name, long stackSize = DEFAULT_STACK_SIZE, ThreadPriority priority = THREAD_PRIORITY_MID);
@@ -206,13 +206,13 @@ public:
 
        /**
         * Called before the message loop is started. @n
-        * If this method returns @c false, the thread is terminated immediately.
+        * If the %OnStart() method returns @c false, the thread is terminated immediately.
         *
         * @since 2.0
         *
-        * @return              @c true if this thread can be run, @n
-        *                              else @c false
-        * @remarks             You can initialize the event or event listener in this method for running this thread.
+        * @return              @c true if this thread runs, @n
+        *                      else @c false
+        * @remarks             The event or event listener in this method can be initialized for running this thread.
         *
         */
        virtual bool OnStart(void);
@@ -222,7 +222,7 @@ public:
         *
         * @since 2.0
         *
-        * @remarks     You can finalize the event or event listener in this method for running this thread.
+        * @remarks     The event or event listener in this method can be finalized for running this thread.
         *
         */
        virtual void OnStop(void);
@@ -236,12 +236,12 @@ public:
         *               If overridden, it may not work as expected.
         *
         * @return       An error code
-        * @param[in]    requestId       The user-defined event ID
-        * @param[in]    pArgs           A pointer to a list of arguments
-        * @exception    E_SUCCESS         The method is successful.
-        * @exception    E_INVALID_STATE   The thread is in an invalid state.
-        * @exception    E_OUT_OF_MEMORY The memory is insufficient.
-        * @exception    E_SYSTEM          A system error has occurred.
+        * @param[in]    requestId              The user-defined event ID
+        * @param[in]    pArgs                  A pointer to the list of arguments
+        * @exception    E_SUCCESS          The method is successful.
+        * @exception    E_INVALID_STATE    The thread is in an invalid state.
+        * @exception    E_OUT_OF_MEMORY    The memory is insufficient.
+        * @exception    E_SYSTEM           A system error has occurred.
         *
         * @see          OnUserEventReceivedN()
         */
@@ -253,7 +253,7 @@ public:
         * @since 2.0
         *
         * @param[in]    requestId       The user-defined event ID
-        * @param[in]    pArgs           A pointer to a list of arguments
+        * @param[in]    pArgs           A pointer to the list of arguments
         *
         * @see          SendUserEvent()
         */