Update Runtime document from LB
[platform/framework/native/appfw.git] / inc / FBaseRtMemoryManager.h
index 82e0da5..4a93d05 100644 (file)
@@ -39,13 +39,13 @@ namespace Tizen { namespace Base { namespace Runtime {
 enum MemoryProtectionMode
 {
        MEMORY_PROTECTION_MODE_NONE   = 0x0,   /**< The memory cannot be accessed */
-       MEMORY_PROTECTION_MODE_READ   = 0x1,  /**< The memory can be read */
-       MEMORY_PROTECTION_MODE_WRITE  = 0x2,  /**< The memory can be modified */
-       MEMORY_PROTECTION_MODE_EXEC  = 0x4,  /**< The memory can be executed */
+       MEMORY_PROTECTION_MODE_READ   = 0x1,   /**< The memory can be read */
+       MEMORY_PROTECTION_MODE_WRITE  = 0x2,   /**< The memory can be modified */
+       MEMORY_PROTECTION_MODE_EXEC  = 0x4,    /**< The memory can be executed */
 };
 
 /**
- *  @class             MemoryManager
+ *  @class     MemoryManager
  *     @brief  This class represents a memory manager for runtime.
  *
  *     @since 2.0
@@ -86,19 +86,21 @@ class _OSP_EXPORT_ MemoryManager
 {
 public:
        /**
-        * Changes protection on a memory region.
+        * Changes the protection on a memory region.
         *
         * @since 2.0
         *
         * @return      An error code
-        * @param[in]   pAddress        The start address of the memory region aligned on a page boundary.
+        * @param[in]   pAddress        The start address of the memory region aligned on a page boundary
         * @param[in]   length          The length of the memory region in bytes
         * @param[in]   protection      The memory protection @n
         *                              It is either Tizen::Base::Runtime::MEMORY_PROTECTION_MODE_NONE or a bitwise OR of the
         *                              other values in Tizen::Base::Runtime::MemoryProtectionMode.
         * @exception   E_SUCCESS       The method is successful.
         * @exception   E_SYSTEM        A system error has occurred due to an invalid address.
-        * @exception   E_INVALID_ARG   The memory address is not valid, or the length is not a multiple of system page size.
+        * @exception   E_INVALID_ARG   Either of the following conditions has occurred:
+        *                                                              - The memory address is invalid.
+        *                                                              - The specified @c length is not a multiple of the system page size.
         */
        static result ProtectMemory(const void* pAddress, long long length, unsigned long protection);