Enable build with iniparser v 3.1
[platform/framework/native/appfw.git] / inc / FBaseRtMonitor.h
index 35e2ab3..1fc48fd 100755 (executable)
@@ -35,17 +35,17 @@ class _MonitorImpl;
 
 /**
  * @class   Monitor
- * @brief      This represents a monitor; a type of synchronization mechanism that provides acquire/release semantics by Enter() / Exit() as well as wait/notify semantics by Wait() / Notify() / NotifyAll().
+ * @brief      This class represents a monitor that is a type of synchronization mechanism.
  *
  * @since 2.0
  *
  * @final This class is not intended for extension.
  *
- * The %Monitor class represents a monitor. %Monitor is a synchronization mechanism that provides acquire/release semantics by Enter() / Exit() as well as wait/notify semantics by Wait() / Notify() / NotifyAll().
+ * The %Monitor class represents a monitor. A %Monitor is a synchronization mechanism that provides acquire and release semantics by Enter() and Exit() as well as wait and notify semantics by Wait(), Notify(), and NotifyAll().
  *
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/monitor.htm">Monitor</a>.
  *
- * The following examples demonstrates how to use the %Monitor class. In the examples, 2 classes, Consumer and Producer, share a space.
+ * The following examples demonstrates how to use the %Monitor class. In the examples, two classes, Consumer and Producer, share a space.
  * Producer writes some data to this space, and Consumer reads it. Consumer and Producer run simultaneously.
  * Consumer must not miss the data which Producer writes. In this case, Consumer and Producer share the monitor.
  * Producer notifies Consumer that its writing action is done. Consumer waits for this notification, and reads the data after receiving it.
@@ -287,39 +287,39 @@ public:
         * @since 2.0
         *
         * @return              An error code
-        * @exception   E_SUCCESS       The method is successful.
+        * @exception   E_SUCCESS               The method is successful.
         * @exception   E_OUT_OF_MEMORY The memory is insufficient.
-        * @exception   E_SYSTEM        A system error has occurred.
+        * @exception   E_SYSTEM                A system error has occurred.
         */
        result Construct(void);
 
        /**
-        * Acquires a lock for a monitor. @n
-        * Semantically, this method declares the beginning of the critical region for the monitor. This region
+        * Acquires a lock for the monitor. @n
+        * Semantically, the %Enter() method declares the beginning of the critical region for the monitor. This region
         * ends with the Exit() method.
         *
         * @since 2.0
         *
         * @return              An error code
-        * @exception   E_SUCCESS       The method is successful in acquiring the lock.
+        * @exception   E_SUCCESS       The method is successful.
         * @exception   E_SYSTEM        A system error has occurred.
-        * @remarks             This method will block if called on already locked monitor object until monitor becomes available.
+        * @remarks             This method blocks if called on an already locked monitor object until the monitor becomes available.
         * @see                 Exit()
         */
        result Enter(void);
 
 
        /**
-        * Releases a lock for a monitor. @n
+        * Releases the lock for the monitor. @n
         * Semantically, it declares the ending of the critical region for the monitor that begins with
         * the Enter() method.
         *
         * @since 2.0
         *
         * @return              An error code
-        * @exception   E_SUCCESS       The method is successful in releasing the lock.
+        * @exception   E_SUCCESS       The method is successful.
         * @exception   E_SYSTEM        A system error has occurred.
-        * @remarks             This method should be called only after acquiring lock by Enter() call
+        * @remarks             This method should be called only after acquiring the lock by the Enter() call.
         * @see                 Enter()
         */
        result Exit(void);
@@ -334,7 +334,7 @@ public:
         * @return              An error code
         * @exception   E_SUCCESS       The method is successful.
         * @exception   E_SYSTEM        A system error has occurred.
-        * @remarks             This method should be called only after acquiring lock by Enter() call
+        * @remarks             This method should be called only after acquiring the lock by the Enter() call.
         * @see                 Notify()
         * @see                 NotifyAll()
         */
@@ -356,7 +356,7 @@ public:
 
 
        /**
-        * Notifies all waiting threads.
+        * Notifies all the waiting threads.
         *
         * @since 2.0
         *