summaryrefslogtreecommitdiff
path: root/src/lib/ecore_file/ecore_file_monitor.c
diff options
context:
space:
mode:
authorJee-Yong Um <conr2d@gmail.com>2016-10-04 21:08:17 +0900
committerHermet Park <hermet@hermet.pe.kr>2016-10-04 21:08:17 +0900
commit3b4293ffa334303ccd2de0422d56a21873afcba0 (patch)
tree51ac1118cb56068bc74f2985120dcee688543ba9 /src/lib/ecore_file/ecore_file_monitor.c
parent72125bd8c3e5e3d2d28d847c1a0ab4e02e3dccc8 (diff)
ecore_file/ipc: clean up documentation
Summary: move comment from c source to header and adjust ingroup relationship Reviewers: cedric, jpeg, Hermet Reviewed By: Hermet Differential Revision: https://phab.enlightenment.org/D4328
Diffstat (limited to 'src/lib/ecore_file/ecore_file_monitor.c')
-rw-r--r--src/lib/ecore_file/ecore_file_monitor.c49
1 files changed, 0 insertions, 49 deletions
diff --git a/src/lib/ecore_file/ecore_file_monitor.c b/src/lib/ecore_file/ecore_file_monitor.c
index 7b4f625534..3fb839b2eb 100644
--- a/src/lib/ecore_file/ecore_file_monitor.c
+++ b/src/lib/ecore_file/ecore_file_monitor.c
@@ -18,29 +18,6 @@ ecore_file_monitor_shutdown(void)
18 ecore_file_monitor_backend_shutdown(); 18 ecore_file_monitor_backend_shutdown();
19} 19}
20 20
21/**
22 * @addtogroup Ecore_File_Group Ecore_File - Files and directories convenience functions
23 *
24 * @{
25 */
26
27/**
28 * @brief Monitor the given path using inotify, Windows notification, or polling.
29 *
30 * @param path The path to monitor.
31 * @param func The function to call on changes.
32 * @param data The data passed to func.
33 * @return An Ecore_File_Monitor pointer or NULL on failure.
34 *
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
37 * notification or polling) is available, or if @p path does not exist
38 * the function returns @c NULL. Otherwise, it returns a newly
39 * allocated Ecore_File_Monitor object and the monitoring begins.
40 * When one of the Ecore_File_Event event is notified, @p func is called
41 * and @p data is passed to @p func.Call ecore_file_monitor_del() to
42 * stop the monitoring.
43 */
44EAPI Ecore_File_Monitor * 21EAPI Ecore_File_Monitor *
45ecore_file_monitor_add(const char *path, 22ecore_file_monitor_add(const char *path,
46 Ecore_File_Monitor_Cb func, 23 Ecore_File_Monitor_Cb func,
@@ -53,17 +30,6 @@ ecore_file_monitor_add(const char *path,
53 return ecore_file_monitor_backend_add(path, func, data); 30 return ecore_file_monitor_backend_add(path, func, data);
54} 31}
55 32
56/**
57 * @brief Stop the monitoring of the given path.
58 *
59 * @param em The Ecore_File_Monitor to stop.
60 *
61 * This function stops the the monitoring of the path that has been
62 * monitored by ecore_file_monitor_add(). @p em must be the value
63 * returned by ecore_file_monitor_add(). If @p em is @c NULL, or none
64 * of the notify methods (Inotify, Windows notification or polling) is
65 * availablethis function does nothing.
66 */
67EAPI void 33EAPI void
68ecore_file_monitor_del(Ecore_File_Monitor *em) 34ecore_file_monitor_del(Ecore_File_Monitor *em)
69{ 35{
@@ -72,24 +38,9 @@ ecore_file_monitor_del(Ecore_File_Monitor *em)
72 ecore_file_monitor_backend_del(em); 38 ecore_file_monitor_backend_del(em);
73} 39}
74 40
75/**
76 * @brief Get the monitored path.
77 *
78 * @param em The Ecore_File_Monitor to query.
79 * @return The path that is monitored by @p em.
80 *
81 * This function returns the monitored path that has been
82 * monitored by ecore_file_monitor_add(). @p em must be the value
83 * returned by ecore_file_monitor_add(). If @p em is @c NULL, the
84 * function returns @c NULL.
85 */
86EAPI const char * 41EAPI const char *
87ecore_file_monitor_path_get(Ecore_File_Monitor *em) 42ecore_file_monitor_path_get(Ecore_File_Monitor *em)
88{ 43{
89 EINA_SAFETY_ON_NULL_RETURN_VAL(em, NULL); 44 EINA_SAFETY_ON_NULL_RETURN_VAL(em, NULL);
90 return em->path; 45 return em->path;
91} 46}
92
93/**
94 * @}
95 */