forked from enlightenment/efl
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
This commit is contained in:
parent
fc2fbcc7b8
commit
61d2e8cdf6
|
@ -34,12 +34,11 @@ ecore_file_monitor_shutdown(void)
|
||||||
*
|
*
|
||||||
* This function monitors @p path. If @p path is @c NULL, or is an
|
* This function monitors @p path. If @p path is @c NULL, or is an
|
||||||
* empty string, or none of the notify methods (Inotify, Windows
|
* empty string, or none of the notify methods (Inotify, Windows
|
||||||
* notification or polling) is available, or if @p path is not a file,
|
* notification or polling) is available, the function returns @c NULL.
|
||||||
* the function returns @c NULL. Otherwise, it returns a newly
|
* Otherwise, it returns a newly allocated Ecore_File_Monitor object
|
||||||
* allocated Ecore_File_Monitor object and the monitoring begins. When
|
* and the monitoring begins. When one of the Ecore_File_Event
|
||||||
* one of the Ecore_File_Event event is notified, @p func is called
|
* event is notified, @p func is called and @p data is passed to @p func.
|
||||||
* and @p data is passed to @p func. Call ecore_file_monitor_del() to
|
* Call ecore_file_monitor_del() to stop the monitoring.
|
||||||
* stop the monitoring.
|
|
||||||
*/
|
*/
|
||||||
EAPI Ecore_File_Monitor *
|
EAPI Ecore_File_Monitor *
|
||||||
ecore_file_monitor_add(const char *path,
|
ecore_file_monitor_add(const char *path,
|
||||||
|
|
Loading…
Reference in New Issue