Revise doxygen

Change-Id: I35ec9e7cc2c5a87e4b53fe64ff0afdc78e5baa99
Signed-off-by: Hyunbin Lee <hyunbin.lee@samsung.com>

diff --git a/inc/FIoDirEnumerator.h b/inc/FIoDirEnumerator.h
index 919299b..b39969f 100644 (file)
--- a/inc/FIoDirEnumerator.h
+++ b/inc/FIoDirEnumerator.h
@@ -160,8 +160,7 @@ public:
        *                                                                               - The length of the specified path is @c 0 or exceeds
        *                                                                                 system limitations. @n
        *                                                                               - The specified path is invalid. @n
-       *                                                                               - The file handle is invalid (either the file is closed by
-       *                                                                                 another method, or the memory is corrupted).
+       *                                                                               - The file handle is invalid (the file is closed by another method).
        * @exception        E_FILE_NOT_FOUND    An entry for the specified file or path cannot be found.
        * @exception        E_MAX_EXCEEDED              The number of opened files has exceeded the maximum limit.
        * @exception        E_END_OF_FILE               There are no more directory entries to read.
@@ -179,7 +178,7 @@ public:
        *
        * @return                       An error code
        * @exception            E_SUCCESS                       The method is successful.
-       * @exception            E_INVALID_ARG           The file handle is invalid (either the file is closed by another method, or the memory is corrupted).
+       * @exception            E_INVALID_ARG           The file handle is invalid (the file is closed by another method).
        */
        virtual result Reset(void);
 

diff --git a/inc/FIoFile.h b/inc/FIoFile.h
index 418deae..246e447 100644 (file)
--- a/inc/FIoFile.h
+++ b/inc/FIoFile.h
@@ -455,8 +455,7 @@ public:
        * @return                       An error code
        * @param[out]           buffer                          A reference to the buffer where the data is copied
        * @exception            E_SUCCESS                       The method is successful.
-       * @exception            E_INVALID_ARG           The file handle is invalid (either the file is closed by another method, or the
-       *                                                                               memory is corrupted).
+       * @exception            E_INVALID_ARG           The specified @c buffer is invalid.
        * @exception            E_ILLEGAL_ACCESS        Either of the following conditions has occurred: @n
        *                                                                               - The file is not opened for read operation. @n
        *                                                                               - Access is denied due to insufficient permission.
@@ -488,8 +487,7 @@ public:
        * @return                       An error code
        * @param[in]            buffer                          A reference to the buffer that contains byte data to write
        * @exception            E_SUCCESS                       The method is successful.
-       * @exception            E_INVALID_ARG           The file handle is invalid (either the file is closed by another method, or the
-       *                                                                               memory is corrupted).
+       * @exception            E_INVALID_ARG           The specified @c buffer is invalid.
        * @exception            E_ILLEGAL_ACCESS        Either of the following conditions has occurred: @n
        *                                                                               - The file is not opened for write operation. @n
        *                                                                               - Access is denied due to insufficient permission.
@@ -551,16 +549,15 @@ public:
        result Write(const Tizen::Base::String& buffer);
 
        /**
-       * Flushes the internally buffered data.
+       * Flushes the internally buffered data to kernel memory of the underlying operating system.
        *
        * @since                        2.0
        *
        * @return                       An error code
        * @exception            E_SUCCESS                       The method is successful.
        * @exception            E_ILLEGAL_ACCESS        Access is denied due to insufficient permission.
-       * @exception            E_INVALID_ARG           The file handle is invalid (either the file is closed by another method, or the
-       *                                                                               memory is corrupted).
-       * @exception        E_IO                                Either of the following conditions has occurred: @n
+       * @exception            E_STORAGE_FULL          The disk space is full.
+       * @exception            E_IO                            Either of the following conditions has occurred: @n
        *                                                                               - An unexpected device failure has occurred as the media ejected suddenly. @n
        *                                                                               - %File corruption is detected.
        */
@@ -577,8 +574,6 @@ public:
        * @return                       The offset of the current file pointer, @n
        *                                       else @c -1L if an error occurs
        * @exception        E_SUCCESS                   The method is successful.
-       * @exception            E_INVALID_ARG           The file handle is invalid (either the file is closed by another method, or the
-       *                                                                               memory is corrupted).
        * @exception        E_IO                                Either of the following conditions has occurred: @n
        *                                                                               - An unexpected device failure has occurred as the media ejected suddenly. @n
        *                                                                               - %File corruption is detected.