Revise Tizen::Io doxygen

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

diff --git a/inc/FBaseRtMutex.h b/inc/FBaseRtMutex.h
index 49cca8a..c9bb61b 100755 (executable)
--- a/inc/FBaseRtMutex.h
+++ b/inc/FBaseRtMutex.h
@@ -34,8 +34,8 @@ namespace Tizen { namespace Base { namespace Runtime
 /**
  * @struct     NonRecursiveMutexTag
  *
- * This struct is used only for providing the non-recursive type of mutex.
- * A non-recursive mutex is a mutex that can not be acquired multiple times by the locking thread. It returns an exception if the locking thread tries to lock the same mutex.
+ * This struct is used only for providing the non-recursive type of the mutex.
+ * A non-recursive mutex is a mutex that cannot be acquired multiple times by the locking thread. It returns an exception if the locking thread tries to lock the same mutex.
  *
  * @since 2.1
  *
@@ -135,14 +135,14 @@ public:
 
        /**
         *      Creates an unnamed mutex which is a recursive mutex that can be acquired multiple times by the locking thread. 
-        *     It keeps the number of getting locked and you must unlock it the same number of times.
+        *  It keeps the number of locks and you must unlock it the same number of times.
         *
         *      @since 2.0
         *
-        *      @return                 An error code
-        *      @exception      E_SUCCESS               The method is successful.
+        *      @return         An error code
+        *      @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 Create(void);
 
@@ -151,7 +151,7 @@ public:
         *
         *      @since 2.1
         *
-        *      @return                 An error code
+        *      @return         An error code
         *      @exception      E_SUCCESS               The method is successful.
         *      @exception      E_SYSTEM                A system error has occurred.
         */
@@ -159,15 +159,15 @@ public:
 
        /**
         *      Creates a named mutex which is a recursive mutex that can be acquired multiple times by the locking thread. 
-        *     It keeps the number of getting locked and you must unlock it the same number of times. @n
+        *  It keeps the number of locks and you must unlock it the same number of times. @n
         *      If a mutex with the specified name already exists, this creates a mutex which references that particular mutex.
         *
         *      @since 2.0
         *
-        *      @return                 An error code
+        *      @return         An error code
         *      @param[in]      name                    The name of the mutex
         *      @exception      E_SUCCESS               The method is successful.
-        *      @exception      E_OUT_OF_MEMORY         The memory is insufficient.
+        *      @exception      E_OUT_OF_MEMORY The memory is insufficient.
         *      @exception      E_SYSTEM                A system error has occurred.
         */
        result Create(const Tizen::Base::String& name);
@@ -177,10 +177,10 @@ public:
         *
         *      @since 2.0
         *
-        *      @return                 An error code
+        *      @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 Acquire()/ TryToAcquire() call
+        *      @exception      E_SYSTEM                A system error has occurred.
+        *      @remarks        This method should be called only after acquiring a lock by calling Acquire() or TryToAcquire().
         */
        result Release(void);
 
@@ -191,24 +191,24 @@ public:
         *
         *      @since 2.0
         *
-        *      @return                 An error code
+        *      @return         An error code
         *      @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 mutex becomes available.
+        *      @remarks        This method blocks if called on an already locked monitor object until the mutex becomes available.
         */
        result Acquire(void);
 
        /**
         *      Tries to acquire the mutex if it is not acquired. @n
-        *      If the mutex is already acquired by another thread, E_OBJECT_LOCKED is returned.
+        *      If the mutex is already acquired by another thread, @c E_OBJECT_LOCKED is returned.
         *
         *      @since 2.0
         *
-        *      @return                 An error code
-        *      @exception      E_SUCCESS               The method is successful.
-        *      @exception      E_OBJECT_LOCKED         The mutex is already locked.
-        *      @exception      E_SYSTEM                A system error has occurred.
-        *      @remarks        This method will block if called on already locked monitor object until mutex becomes available.
+        *      @return         An error code
+        *      @exception      E_SUCCESS                The method is successful.
+        *      @exception      E_OBJECT_LOCKED  The mutex is already locked.
+        *      @exception      E_SYSTEM                 A system error has occurred.
+        *      @remarks        This method blocks if called on an already locked monitor object until the mutex becomes available.
         */
        result TryToAcquire(void);