[Ecore_File] rename parameter for doxygen 94/155694/2
authorJinYong Park <j4939.park@samsung.com>
Mon, 16 Oct 2017 02:58:16 +0000 (11:58 +0900)
committerGerrit Code Review <gerrit@review.ap-northeast-2.compute.internal>
Mon, 16 Oct 2017 03:16:26 +0000 (03:16 +0000)
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

https://phab.enlightenment.org/D5313

Change-Id: I371bea0d3d3b6e66602385452d8555159bdcb44f
Signed-off-by: JinYong Park <j4939.park@samsung.com>
src/lib/ecore_file/Ecore_File.h
src/lib/ecore_file/ecore_file.c

index 2a44a19..dd4f49e 100644 (file)
@@ -467,7 +467,7 @@ EAPI const char    *ecore_file_file_get     (const char *path);
  * @elseif WEARABLE @since_tizen 3.0
  * @endif
  */
-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.
@@ -518,7 +518,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
@@ -604,7 +604,7 @@ EAPI char          *ecore_file_escape_name  (const char *filename);
  * @elseif WEARABLE @since_tizen 3.0
  * @endif
  */
-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.
@@ -665,7 +665,7 @@ EAPI Ecore_File_Monitor *ecore_file_monitor_add(const char *path,
  * @elseif WEARABLE @since_tizen 3.0
  * @endif
  */
-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.
@@ -682,7 +682,7 @@ EAPI void                ecore_file_monitor_del(Ecore_File_Monitor *ecore_file_m
  * @elseif WEARABLE @since_tizen 3.0
  * @endif
  */
-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 a9a98bf..5aea423 100644 (file)
@@ -635,12 +635,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);
 }