X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFIoFileEventManager.h;h=d2a9d36819b3e82e2e7222c4186666e32ec75407;hb=b54953ec1a6df32b1f10ce54ec189c9a3ad826b0;hp=6e30ef60e8fcca24a08b5c0173f7c11761fe0dcd;hpb=710e9dd7a17cc6db724372e9ad85ce9a828659d1;p=platform%2Fframework%2Fnative%2Fappfw.git

diff --git a/inc/FIoFileEventManager.h b/inc/FIoFileEventManager.h
index 6e30ef6..d2a9d36 100644
--- a/inc/FIoFileEventManager.h
+++ b/inc/FIoFileEventManager.h
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -47,22 +46,22 @@ class _FileEventManagerImpl;
  */
 enum FileEventType
 {
-	FILE_EVENT_TYPE_ACCESS = 0x01, /**<%File was accessed (read)*/
-	FILE_EVENT_TYPE_ATTRIBUTE = 0x04, /**<Metadata changed*/
-	FILE_EVENT_TYPE_CLOSE_WRITE = 0x08, /**<%File opened for writing was closed*/
-	FILE_EVENT_TYPE_CLOSE_NOWRITE = 0x10, /**<%File not opened for writing was closed*/
-	FILE_EVENT_TYPE_CREATE = 0x100, /**<%File/directory created in monitored directory*/
-	FILE_EVENT_TYPE_DELETE = 0x200, /**<%File/directory deleted from monitored directory*/
-	FILE_EVENT_TYPE_DELETE_SELF = 0x400, /**<Monitored file/directory was itself deleted.*/
-	FILE_EVENT_TYPE_MODIFY = 0x02, /**<%File was modified*/
-	FILE_EVENT_TYPE_MOVE_SELF = 0x800, /**<Monitored file/directory was itself moved.*/
-	FILE_EVENT_TYPE_MOVED_FROM = 0x40, /**<%File moved out of monitored directory. */
-	FILE_EVENT_TYPE_MOVED_TO = 0x80, /**<%File moved into monitored directory. */
-	FILE_EVENT_TYPE_OPEN = 0x20 /**<%File was opened. */
+	FILE_EVENT_TYPE_ACCESS = 0x01, /**< %File was accessed (read) */
+	FILE_EVENT_TYPE_ATTRIBUTE = 0x04, /**< Metadata was changed */
+	FILE_EVENT_TYPE_CLOSE_WRITE = 0x08, /**< %File opened for writing was closed */
+	FILE_EVENT_TYPE_CLOSE_NOWRITE = 0x10, /**< %File not opened for writing was closed */
+	FILE_EVENT_TYPE_CREATE = 0x100, /**< %File/directory created in monitored directory */
+	FILE_EVENT_TYPE_DELETE = 0x200, /**< %File/directory deleted from monitored directory */
+	FILE_EVENT_TYPE_DELETE_SELF = 0x400, /**< Monitored file/directory was itself deleted */
+	FILE_EVENT_TYPE_MODIFY = 0x02, /**< %File was modified */
+	FILE_EVENT_TYPE_MOVE_SELF = 0x800, /**< Monitored file/directory was itself moved.*/
+	FILE_EVENT_TYPE_MOVED_FROM = 0x40, /**< %File moved out of monitored directory */
+	FILE_EVENT_TYPE_MOVED_TO = 0x80, /**< %File moved into monitored directory */
+	FILE_EVENT_TYPE_OPEN = 0x20 /**< %File was opened */
 };
 
 /**
- * All file event types.
+ * All the file event types.
  *
  * @since 2.0
  */
@@ -72,13 +71,14 @@ static const unsigned long FILE_EVENT_TYPE_ALL = FILE_EVENT_TYPE_ACCESS | FILE_E
 
 /**
  * @class	FileEventManager
- * @brief	This class provides a mechanism for monitoring file system events.
+ * @brief	This class provides methods for monitoring file system events.
  *
  * @since	2.0
  *
  * @final	This class is not intended for extension.
  *
- * The %FileEventManager class can be used to monitor individual files or directories. When a directory is monitored, this class will send an event for the directory or file itself, and for sub-files or sub-directories inside the observed directory.
+ * The %FileEventManager class can be used to monitor individual files or directories. When a directory is monitored,
+ * this class will send an event for the directory or file itself, and for sub-files or sub-directories inside the observed directory.
  *
  * @code
  *
@@ -123,7 +123,8 @@ class _OSP_EXPORT_ FileEventManager
 
 public:
 	/**
-	* The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+	* The object is not fully constructed after this constructor is called. @n
+	* For full construction, the Construct() method must be called right after calling this constructor.
 	*
 	* @since		2.0
 	*/
@@ -137,51 +138,52 @@ public:
 	virtual ~FileEventManager(void);
 
 	/**
-	* Initializes this instance of %FileEventManager. @n
+	* Initializes this instance of %FileEventManager.
 	*
 	* @since		2.0
 	*
 	* @return		An error code
-	* @param[in]	listener			A listener invoked when monitored files are changed.
+	* @param[in]	listener			The listener to be invoked when monitored files are changed
 	* @exception	E_SUCCESS			The method is successful.
 	* @exception	E_MAX_EXCEEDED		The number of opened files has exceeded the maximum limit.
-	* @exception	E_IO				Either of the following conditions has occurred: @n
-	*									- Fail to attach on platform.
+	* @exception	E_IO				Either of the following conditions has occurred:
+	*									- The specified listener cannot be registered in worker thread.
 	*									- Detected corruption of a file.
 	*/
 	result Construct(IFileEventListener& listener);
 
 
 	/**
-	* Adds a new monitor file, or modifies an existing monitor file, for the file whose location is specified in path; the application has to have read permission for this %path. %File event type can be set in %eventsToMonitor.
+	* Adds the monitor file, or modifies an existing monitor file in the specified path. @n
+	* The application must have read permission for this @c path. The file event type can be set in @c eventsToMonitor.
 	*
 	* @since		2.0
 	*
 	* @return		An error code
 	* @param[in]	path				The path to the directory or file to monitor
 	* @param[in]	eventsToMonitor		The kind of event to monitor @n
-	*									Multiple event type can be combined using bitwise OR (see Tizen::Io::FileEventType). @n
-	*									The Tizen::Io::FILE_EVENT_TYPE_ALL is provided for all file event type @n
-	*									If a specific eventsToMonitor is set, the events that have the specified file event are returned.
+	*									Multiple event types can be combined using bitwise OR (see Tizen::Io::FileEventType). @n
+	*									The ::FILE_EVENT_TYPE_ALL is provided for all file event types. @n
+	*									If a specific @c eventsToMonitor is set, the events that have the specified file event are returned.
 	* @exception	E_SUCCESS			The method is successful.
 	* @exception	E_INVALID_ARG		The specified eventsToMonitor contains no valid events.
 	* @exception	E_FILE_NOT_FOUND	An entry for the specified path could not be found.
 	* @exception	E_ILLEGAL_ACCESS	The specified path is not permitted.
-	* @exception	E_IO				Either of the following conditions has occurred: @n
-	*									- The specified path outside of the process's accessible address space. @n
-	*									- The number of file monitor has been exceeded the maximum limit or
-	*									  the failed to allocate a needed resource. @n
+	* @exception	E_IO				Either of the following conditions has occurred:
+	*									- The specified path is outside the process's accessible address space.
+	*									- The number of file monitors has exceeded the maximum limit.
+	*									- Failed to allocate a needed resource.
 	*									- Detected corruption of a file.
 	* @see			FileEventType
 	*/
 	result AddPath(const Tizen::Base::String& path, unsigned long eventsToMonitor);
 
 	/**
-	* Removes the monitored file associated with the current instance.
+	* Removes the specified monitored file associated with the current instance.
 	*
 	* @since		2.0
 	*
-	* @return		An error code
+	* @return			An error code
 	* @param[in]		path			The path to the directory or file that is monitored
 	* @exception		E_SUCCESS		The method is successful.
 	* @exception		E_IO			The specified path is not monitored.