diff options
author | Jee-Yong Um <conr2d@gmail.com> | 2016-10-04 21:08:17 +0900 |
---|---|---|
committer | Hermet Park <hermet@hermet.pe.kr> | 2016-10-04 21:08:17 +0900 |
commit | 3b4293ffa334303ccd2de0422d56a21873afcba0 (patch) | |
tree | 51ac1118cb56068bc74f2985120dcee688543ba9 /src/lib/ecore_file/ecore_file_path.c | |
parent | 72125bd8c3e5e3d2d28d847c1a0ab4e02e3dccc8 (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 '')
-rw-r--r-- | src/lib/ecore_file/ecore_file_path.c | 43 |
1 files changed, 0 insertions, 43 deletions
diff --git a/src/lib/ecore_file/ecore_file_path.c b/src/lib/ecore_file/ecore_file_path.c index 71fdb680ec..0c4e466ce5 100644 --- a/src/lib/ecore_file/ecore_file_path.c +++ b/src/lib/ecore_file/ecore_file_path.c | |||
@@ -68,23 +68,6 @@ _ecore_file_path_from_env(const char *env) | |||
68 | return path; | 68 | return path; |
69 | } | 69 | } |
70 | 70 | ||
71 | /** | ||
72 | * @addtogroup Ecore_File_Group Ecore_File - Files and directories convenience functions | ||
73 | * | ||
74 | * @{ | ||
75 | */ | ||
76 | |||
77 | /** | ||
78 | * @brief Check if the given directory is in PATH. | ||
79 | * | ||
80 | * @param in_dir The name of the directory to search in PATH. | ||
81 | * @return @c EINA_TRUE if the directory exist in PATH, @c EINA_FALSE otherwise. | ||
82 | * | ||
83 | * This function checks if @p in_dir is in the environment variable | ||
84 | * PATH. If @p in_dir is @c NULL, or if PATH is empty, or @p in_dir is | ||
85 | * not in PATH, the function returns @c EINA_FALSE, otherwise it returns | ||
86 | * @c EINA_TRUE. | ||
87 | */ | ||
88 | EAPI Eina_Bool | 71 | EAPI Eina_Bool |
89 | ecore_file_path_dir_exists(const char *in_dir) | 72 | ecore_file_path_dir_exists(const char *in_dir) |
90 | { | 73 | { |
@@ -104,17 +87,6 @@ ecore_file_path_dir_exists(const char *in_dir) | |||
104 | return EINA_FALSE; | 87 | return EINA_FALSE; |
105 | } | 88 | } |
106 | 89 | ||
107 | /** | ||
108 | * @brief Check if the given application is installed. | ||
109 | * | ||
110 | * @param exe The name of the application | ||
111 | * @return @c EINA_TRUE if the @p exe is in PATH and is executable, | ||
112 | * @c EINA_FALSE otherwise. | ||
113 | * | ||
114 | * This function checks if @p exe exists in PATH and is executable. If | ||
115 | * @p exe is @c NULL or is not executable, the function returns | ||
116 | * @c EINA_FALSE, otherwise it returns @c EINA_TRUE. | ||
117 | */ | ||
118 | EAPI Eina_Bool | 90 | EAPI Eina_Bool |
119 | ecore_file_app_installed(const char *exe) | 91 | ecore_file_app_installed(const char *exe) |
120 | { | 92 | { |
@@ -135,17 +107,6 @@ ecore_file_app_installed(const char *exe) | |||
135 | return EINA_FALSE; | 107 | return EINA_FALSE; |
136 | } | 108 | } |
137 | 109 | ||
138 | /** | ||
139 | * @brief Get a list of all the applications installed on the system. | ||
140 | * | ||
141 | * @return An Eina_List containing all the executable files in the | ||
142 | * system. | ||
143 | * | ||
144 | * This function returns a list of allocated strings of all the | ||
145 | * executable files. If no files are found, the function returns | ||
146 | * @c NULL. When not needed anymore, the element of the list must be | ||
147 | * freed. | ||
148 | */ | ||
149 | EAPI Eina_List * | 110 | EAPI Eina_List * |
150 | ecore_file_app_list(void) | 111 | ecore_file_app_list(void) |
151 | { | 112 | { |
@@ -169,7 +130,3 @@ ecore_file_app_list(void) | |||
169 | 130 | ||
170 | return list; | 131 | return list; |
171 | } | 132 | } |
172 | |||
173 | /** | ||
174 | * @} | ||
175 | */ | ||