Ecore File: Corrected documentation of ecore_file_monitor_add API
authorkabeer khan <kabeer.khan@samsung.com>
Tue, 4 Nov 2014 13:53:17 +0000 (08:53 -0500)
committerChris Michael <cp.michael@samsung.com>
Tue, 4 Nov 2014 13:53:33 +0000 (08:53 -0500)
Summary:
Added condition that if given path does not exist it returns NULL

@fix

Signed-off-by: kabeer khan <kabeer.khan@samsung.com>
Reviewers: englebass, devilhorns

Reviewed By: devilhorns

Subscribers: cedric

Differential Revision: https://phab.enlightenment.org/D1640

src/lib/ecore_file/ecore_file_monitor.c

index df038cd..7b4f625 100644 (file)
@@ -34,11 +34,12 @@ ecore_file_monitor_shutdown(void)
  *
  * This function monitors @p path. If @p path is @c NULL, or is an
  * empty string, or none of the notify methods (Inotify, Windows
- * notification or polling) is available, the function returns @c NULL.
- * Otherwise, it returns a newly allocated Ecore_File_Monitor object
- * and the monitoring begins. When one of the Ecore_File_Event 
- * event is notified, @p func is called and @p data is passed to @p func.
- * Call ecore_file_monitor_del() to stop the monitoring.
+ * notification or polling) is available, or if @p path does not exist
+ * the function returns @c NULL. Otherwise, it returns a newly 
+ * allocated Ecore_File_Monitor object and the monitoring begins.
+ * When one of the Ecore_File_Event event is notified, @p func is called
+ * and @p data is passed to @p func.Call ecore_file_monitor_del() to
+ * stop the monitoring.
  */
 EAPI Ecore_File_Monitor *
 ecore_file_monitor_add(const char           *path,