summaryrefslogtreecommitdiff
path: root/src/lib/ecore_file/ecore_file_monitor.c
diff options
context:
space:
mode:
authorkabeer khan <kabeer.khan@samsung.com>2014-11-03 08:13:57 -0500
committerChris Michael <cp.michael@samsung.com>2014-11-03 08:13:57 -0500
commit61d2e8cdf624748656067fb9ea481daad94f314f (patch)
tree591ec9ff51c1d108e296e5f4bad42993fa489ea0 /src/lib/ecore_file/ecore_file_monitor.c
parentfc2fbcc7b884001e56392c151ee4cde0abd9e624 (diff)
Ecore File: Corrected documentation of ecore_file_monitor_add API
Summary: Existing doc specifies that ecore_file_monitor_add returns NULL if path is not file. Removed this line as it works if path is either file or directory. Signed-off-by: kabeer khan <kabeer.khan@samsung.com> Reviewers: devilhorns, englebass Subscribers: cedric Differential Revision: https://phab.enlightenment.org/D1635
Diffstat (limited to 'src/lib/ecore_file/ecore_file_monitor.c')
-rw-r--r--src/lib/ecore_file/ecore_file_monitor.c11
1 files changed, 5 insertions, 6 deletions
diff --git a/src/lib/ecore_file/ecore_file_monitor.c b/src/lib/ecore_file/ecore_file_monitor.c
index c7e5e8a3af..df038cdc8e 100644
--- a/src/lib/ecore_file/ecore_file_monitor.c
+++ b/src/lib/ecore_file/ecore_file_monitor.c
@@ -34,12 +34,11 @@ ecore_file_monitor_shutdown(void)
34 * 34 *
35 * This function monitors @p path. If @p path is @c NULL, or is an 35 * This function monitors @p path. If @p path is @c NULL, or is an
36 * empty string, or none of the notify methods (Inotify, Windows 36 * empty string, or none of the notify methods (Inotify, Windows
37 * notification or polling) is available, or if @p path is not a file, 37 * notification or polling) is available, the function returns @c NULL.
38 * the function returns @c NULL. Otherwise, it returns a newly 38 * Otherwise, it returns a newly allocated Ecore_File_Monitor object
39 * allocated Ecore_File_Monitor object and the monitoring begins. When 39 * and the monitoring begins. When one of the Ecore_File_Event
40 * one of the Ecore_File_Event event is notified, @p func is called 40 * event is notified, @p func is called and @p data is passed to @p func.
41 * and @p data is passed to @p func. Call ecore_file_monitor_del() to 41 * Call ecore_file_monitor_del() to stop the monitoring.
42 * stop the monitoring.
43 */ 42 */
44EAPI Ecore_File_Monitor * 43EAPI Ecore_File_Monitor *
45ecore_file_monitor_add(const char *path, 44ecore_file_monitor_add(const char *path,