//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
*
* 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 <a href="../org.tizen.native.appprogramming/html/guide/io/io_namespace.htm">Io Guide</a>.
* @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
*
/**
* 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.
*
*
* @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
- * - The file handle is invalid (either the file is closed by
- * another method, or the memory is corrupted).
+ * 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);
*
* @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);