summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorkabeer khan <kabeer.khan@samsung.com>2014-11-04 08:53:17 -0500
committerChris Michael <cp.michael@samsung.com>2014-11-04 08:53:33 -0500
commit0abcd5133e4ccb18d1b01f18537b6012268b28f3 (patch)
tree4695b976f97b39142f1ed1a1843c5000071833c8 /src/lib
parent9fa0e6ea19a36f8fdf8e8fb6abb5c05cbf2bfc60 (diff)
Ecore File: Corrected documentation of ecore_file_monitor_add API
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
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/ecore_file/ecore_file_monitor.c11
1 files changed, 6 insertions, 5 deletions
diff --git a/src/lib/ecore_file/ecore_file_monitor.c b/src/lib/ecore_file/ecore_file_monitor.c
index df038cdc8e..7b4f625534 100644
--- a/src/lib/ecore_file/ecore_file_monitor.c
+++ b/src/lib/ecore_file/ecore_file_monitor.c
@@ -34,11 +34,12 @@ 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, the function returns @c NULL. 37 * notification or polling) is available, or if @p path does not exist
38 * Otherwise, it returns a newly allocated Ecore_File_Monitor object 38 * the function returns @c NULL. Otherwise, it returns a newly
39 * and the monitoring begins. When one of the Ecore_File_Event 39 * allocated Ecore_File_Monitor object and the monitoring begins.
40 * event is notified, @p func is called and @p data is passed to @p func. 40 * When one of the Ecore_File_Event event is notified, @p func is called
41 * Call ecore_file_monitor_del() to stop the monitoring. 41 * and @p data is passed to @p func.Call ecore_file_monitor_del() to
42 * stop the monitoring.
42 */ 43 */
43EAPI Ecore_File_Monitor * 44EAPI Ecore_File_Monitor *
44ecore_file_monitor_add(const char *path, 45ecore_file_monitor_add(const char *path,