fixed Doxygen warning

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

diff --git a/inc/FBaseRtMutexGuard.h b/inc/FBaseRtMutexGuard.h
index 541481b..f0a428a 100644 (file)
--- a/inc/FBaseRtMutexGuard.h
+++ b/inc/FBaseRtMutexGuard.h
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -33,11 +32,11 @@ namespace Tizen { namespace Base { namespace Runtime
 
 /**
 * @class       MutexGuard
-* @brief       This class is the RAII style class for %Mutex class.
+* @brief       This class is the RAII style class for the %Mutex class.
 *
 * @since 2.0
 *
-* The following example demonstrates how to use this %MutexGuard class
+* The following example demonstrates how to use the %MutexGuard class
 *
 * @code
 *
@@ -180,7 +179,7 @@ public:
        *
        * @since 2.0
        *
-       * @param[in]    m       The %Mutex instance to be manipulated
+       * @param[in]    m       A %Mutex instance to manipulate
        * @remarks              The specific error code can be accessed using the GetLastResult() method.
        * @see                  Mutex::Acquire() for detailed exceptions
        */
@@ -196,7 +195,7 @@ public:
        *
        * @since 2.0
        *
-       * @param[in]    m       The %Mutex instance to be manipulated
+       * @param[in]    m               A %Mutex instance to be manipulated
        * @remarks              The specific error code can be accessed using the GetLastResult() method.
        * @see                  Mutex::TryToAcquire() for detailed exceptions
        */
@@ -208,7 +207,7 @@ public:
        }
 
        /**
-       * This destructor releases the lock if acquired when going out of a scope
+       * This destructor releases the lock if acquired when going out of the scope
        *
        * @since 2.0
        *
@@ -221,12 +220,12 @@ public:
        }
 
        /**
-       * Returns whether this instance owns the lock on the given mutex at constructor.
+       * Checks whether this instance owns the lock on the given mutex at constructor.
        *
        * @since 2.0
        *
-       * @return       true if the lock is owned, @n
-       *                       false otherwise.
+       * @return       @c true if the lock is owned, @n
+       *                       else @c false
        */
        bool IsLocked(void) const
        {
@@ -234,8 +233,8 @@ public:
        }
 
        /**
-       * Returns whether this instance owns the lock on the given mutex at constructor. @n
-       * Have same effects to calling IsLocked().
+       * Checks whether this instance owns the lock on the given mutex at constructor. @n
+       * Has the same effects as calling IsLocked().
        *
        * @since 2.0
        */
@@ -245,11 +244,11 @@ public:
        }
 
        /**
-       * Acquires the lock manually on the given mutex at constructor in a blocking way
+       * Acquires the lock manually on the given mutex at constructor in a blocking way.
        *
        * @since 2.0
        *
-       * @return       An error code.
+       * @return       An error code
        * @see          Mutex::Acquire() for detailed exceptions
        */
        result Lock(void)
@@ -262,7 +261,7 @@ public:
        *
        * @since 2.0
        *
-       * @return       An error code.
+       * @return       An error code
        * @see          Mutex::TryToAcquire() for detailed exceptions
        */
        result TryToLock(void)
@@ -275,7 +274,7 @@ public:
        *
        * @since 2.0
        *
-       * @return       An error code.
+       * @return       An error code
        * @see          Mutex::Release() for detailed exceptions
        */
        result Unlock(void)