Implementation of ImmutableString

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

diff --git a/inc/FIoFile.h b/inc/FIoFile.h
index dac9cfe..a769e00 100644 (file)
--- a/inc/FIoFile.h
+++ b/inc/FIoFile.h
@@ -215,8 +215,7 @@ public:
        virtual ~File(void);
 
        /**
-       * @{
-       * @if OSPDEPREC
+       * @cond OSPDEPREC
        * Initializes this instance of %File with the specified parameters. @n
        * This method opens an existing file or creates a new one according to the specified file opening mode.
        *
@@ -264,8 +263,7 @@ public:
        * @remarks              The following file opening mode strings are recognized by this method: "w+", "wb+", "w+b", "w", "wb", "a+",
        *                               "ab+", "a+b", "a", "ab", "r+", "rb+", "r+b", "r", "rb". @n
        *                               Other strings lead to E_INVALID_ARG. However, "b"(binary) open mode is ignored internally.
-       * @endif
-       * @}
+       * @endcond
        */
        result Construct(const Tizen::Base::String& filePath, const Tizen::Base::String& openMode, bool createParentDirectories);
 
@@ -457,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.
@@ -490,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.
@@ -553,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.
        */
@@ -579,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.
@@ -676,7 +669,6 @@ public:
        * @exception            E_SYSTEM                                The method cannot proceed due to a severe system error.
        * @remarks                      The %FileLock instance is invalid if the associated %File instance is deleted. @n
        *                                               The specific error code can be accessed using the GetLastResult() method.
-       * @see                          Tizen::Io::File::FileLockType
        */
        FileLock* LockN(FileLockType lockType);
 
@@ -710,7 +702,6 @@ public:
        * @exception            E_SYSTEM                                The method cannot proceed due to a severe system error.
        * @remarks                      The %FileLock instance is invalid if the associated %File instance is deleted. @n
        *                                               The specific error code can be accessed using the GetLastResult() method.
-       * @see                          Tizen::Io::File::FileLockType
        */
        FileLock* LockN(FileLockType lockType, int offset, int length);
 
@@ -737,7 +728,6 @@ public:
        * @exception            E_SYSTEM                                The method cannot proceed due to a severe system error.
        * @remarks                      The %FileLock instance is invalid if the associated %File instance is deleted. @n
        *                                               The specific error code can be accessed using the GetLastResult() method.
-       * @see                          Tizen::Io::File::FileLockType
        */
        FileLock* TryToLockN(FileLockType lockType);
 
@@ -769,7 +759,6 @@ public:
        * @exception            E_SYSTEM                                The method cannot proceed due to a severe system error.
        * @remarks                      The %FileLock instance is invalid if the associated %File instance is deleted. @n
        *                                               The specific error code can be accessed using the GetLastResult() method.
-       * @see                          Tizen::Io::File::FileLockType
        */
        FileLock* TryToLockN(FileLockType lockType, int offset, int length);