X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFIoDirEnumerator.h;h=46d76e2d31ff13658b203096f7a991a2f8396e49;hb=07a771d39ebf4c7f26a04aeb3e06f9d7eb1c6dc2;hp=b39969f649613e2d066a3b94ad055547c310cc5e;hpb=97e25598708011af6ef2f0cdf194682b717d2577;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FIoDirEnumerator.h b/inc/FIoDirEnumerator.h index b39969f..46d76e2 100644 --- a/inc/FIoDirEnumerator.h +++ b/inc/FIoDirEnumerator.h @@ -42,7 +42,7 @@ class DirEntry; * * The %DirEnumerator class provides methods to access the collection of a specific directory entry list. * Generally, %DirEnumerator is instantiated by the Directory::ReadN() method, - * and used to get the %DirEntry instances that have information pertaining to the directory. + * and used to get the DirEntry instances that have information pertaining to the directory. * * For more information on the class features, * see Io Guide. @@ -129,13 +129,14 @@ public: * @return A reference to the DirEntry instance * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The current position of the collection is not valid. - * @remarks Use the MoveNext() method to get information from another file or directory to the currently accessed directory. @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - Use the MoveNext() method to get information from another file or directory to the currently accessed directory. + * - The specific error code can be accessed using the GetLastResult() method. */ DirEntry GetCurrentDirEntry(void) const; /** - * Gets the pointer to the object at the current position of a directory entry collection. + * Gets a pointer to the object at the current position of a directory entry collection. * * @since 2.0 * @@ -147,8 +148,8 @@ public: /** * Moves the current position of the collection to the next position in the currently accessed directory. @n - * When %DirEnumerator is instantiated, its initial position is set to @c -1. @n - * Therefore, calling the GetCurrentDirEntry() method without a call to MoveNext() throws an E_INVALID_STATE exception, + * When DirEnumerator is instantiated, its initial position is set to @c -1. @n + * Therefore, calling the GetCurrentDirEntry() method without a call to MoveNext() throws an @c E_INVALID_STATE exception, * and returns a reference to an empty DirEntry instance. @n * Similarly, calling the GetCurrent() method without a call to MoveNext() returns a @c null pointer to indicate an error condition. * @@ -156,17 +157,17 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The length of the specified path is @c 0 or exceeds - * system limitations. @n - * - The specified path is invalid. @n + * system limitations. + * - The specified path is invalid. * - 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. * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. */ virtual result MoveNext(void);