ecore_file: rename parameter for doxygen
authorJinYong Park <j4939.park@samsung.com>
Fri, 13 Oct 2017 21:02:31 +0000 (14:02 -0700)
committerCedric Bail <cedric@osg.samsung.com>
Fri, 13 Oct 2017 21:02:37 +0000 (14:02 -0700)
Summary:
Some parameter's name are different in annotations and statements,
so it occurs doxygen warning.
To fix it, rename that parameters.

Test Plan: API Doxygen Revision

Reviewers: raster, cedric, jpeg, myoungwoon, Jaehyun_Cho

Reviewed By: cedric

Differential Revision: https://phab.enlightenment.org/D5313

Signed-off-by: Cedric Bail <cedric@osg.samsung.com>
src/lib/ecore_file/Ecore_File.h
src/lib/ecore_file/ecore_file.c

index 9a8402d..57cb550 100644 (file)
@@ -383,7 +383,7 @@ EAPI const char    *ecore_file_file_get     (const char *path);
  * returns @c NULL. When not needed anymore, the returned value must
  * be freed.
  */
-EAPI char          *ecore_file_dir_get      (const char *path);
+EAPI char          *ecore_file_dir_get      (const char *file);
 
 /**
  * @brief Checks if the given file can be read.
@@ -422,7 +422,7 @@ EAPI Eina_Bool      ecore_file_can_exec     (const char *file);
 /**
  * @brief Gets the path pointed by the given link.
  *
- * @param  lnk The name of the link.
+ * @param  link The name of the link.
  * @return The path pointed by link or NULL.
  *
  * This function returns the path pointed by @p link as a newly
@@ -488,7 +488,7 @@ EAPI char          *ecore_file_escape_name  (const char *filename);
  * failure, the function returns @c NULL. When not needed anymore, the
  * returned value must be freed.
  */
-EAPI char          *ecore_file_strip_ext    (const char *file);
+EAPI char          *ecore_file_strip_ext    (const char *path);
 
 /**
  * @brief Checks if the given directory is empty.
@@ -537,7 +537,7 @@ EAPI Ecore_File_Monitor *ecore_file_monitor_add(const char *path,
  * of the notify methods (Inotify, Windows notification or polling) is
  * availablethis function does nothing.
  */
-EAPI void                ecore_file_monitor_del(Ecore_File_Monitor *ecore_file_monitor);
+EAPI void                ecore_file_monitor_del(Ecore_File_Monitor *em);
 
 /**
  * @brief Gets the monitored path.
@@ -550,7 +550,7 @@ EAPI void                ecore_file_monitor_del(Ecore_File_Monitor *ecore_file_m
  * returned by ecore_file_monitor_add(). If @p em is @c NULL, the
  * function returns @c NULL.
  */
-EAPI const char         *ecore_file_monitor_path_get(Ecore_File_Monitor *ecore_file_monitor);
+EAPI const char         *ecore_file_monitor_path_get(Ecore_File_Monitor *em);
 
 /* Path */
 
index f5c15b6..14c1934 100644 (file)
@@ -631,12 +631,12 @@ ecore_file_can_exec(const char *file)
 }
 
 EAPI char *
-ecore_file_readlink(const char *lnk)
+ecore_file_readlink(const char *link)
 {
    char buf[PATH_MAX];
    int count;
 
-   if ((count = readlink(lnk, buf, sizeof(buf) - 1)) < 0) return NULL;
+   if ((count = readlink(link, buf, sizeof(buf) - 1)) < 0) return NULL;
    buf[count] = 0;
    return strdup(buf);
 }