diff options
Diffstat (limited to 'src/lib/efreet/efreet_utils.h')
| -rw-r--r-- | src/lib/efreet/efreet_utils.h | 43 |
1 files changed, 18 insertions, 25 deletions
diff --git a/src/lib/efreet/efreet_utils.h b/src/lib/efreet/efreet_utils.h index aef0511eea..5af80554bd 100644 --- a/src/lib/efreet/efreet_utils.h +++ b/src/lib/efreet/efreet_utils.h @@ -5,8 +5,10 @@ * @file efreet_utils.h * @brief Contains utility functions to ease usage of Efreet. * FDO desktop entry specificiation. - * @addtogroup Efreet_Utils Efreet utilities for FDO - * @ingroup Efreet + * + * @internal + * @defgroup Efreet_Utils_Group Efreet utilities for FDO + * @ingroup Efreet_Group * * @{ */ @@ -16,7 +18,7 @@ * Returns the fdo file id for a given path. If the file isn't inside * a default fdo path it will return NULL. * - * @param path The path to find the file id for + * @param[in] path The path to find the file id for * * @return File id for path or NULL */ @@ -28,7 +30,7 @@ EAPI const char *efreet_util_path_to_file_id(const char *path); * * This list must be freed using EINA_LIST_FREE / efreet_desktop_free * - * @param mime the mime type + * @param[in] mime the mime type * @return a list of desktops */ EAPI Eina_List *efreet_util_desktop_mime_list(const char *mime); @@ -39,8 +41,8 @@ EAPI Eina_List *efreet_util_desktop_mime_list(const char *mime); * * This list must be freed using EINA_LIST_FREE / efreet_desktop_free * - * @param wmname the wm name - * @param wmclass the wm class + * @param[in] wmname the wm name + * @param[in] wmclass the wm class * @return a list of desktops */ EAPI Efreet_Desktop *efreet_util_desktop_wm_class_find(const char *wmname, const char *wmclass); @@ -50,7 +52,7 @@ EAPI Efreet_Desktop *efreet_util_desktop_wm_class_find(const char *wmname, const * * return value must be freed by efreet_desktop_free * - * @param file_id the file id + * @param[in] file_id the file id * @return a desktop */ EAPI Efreet_Desktop *efreet_util_desktop_file_id_find(const char *file_id); @@ -60,7 +62,7 @@ EAPI Efreet_Desktop *efreet_util_desktop_file_id_find(const char *file_id); * * return value must be freed by efreet_desktop_free * - * @param exec the exec name + * @param[in] exec the exec name * @return a desktop */ EAPI Efreet_Desktop *efreet_util_desktop_exec_find(const char *exec); @@ -70,7 +72,7 @@ EAPI Efreet_Desktop *efreet_util_desktop_exec_find(const char *exec); * * return value must be freed by efreet_desktop_free * - * @param name the name + * @param[in] name the name * @return a desktop */ EAPI Efreet_Desktop *efreet_util_desktop_name_find(const char *name); @@ -80,7 +82,7 @@ EAPI Efreet_Desktop *efreet_util_desktop_name_find(const char *name); * * return value must be freed by efreet_desktop_free * - * @param generic_name the generic name + * @param[in] generic_name the generic name * @return a desktop */ EAPI Efreet_Desktop *efreet_util_desktop_generic_name_find(const char *generic_name); @@ -91,7 +93,7 @@ EAPI Efreet_Desktop *efreet_util_desktop_generic_name_find(const char *generic_n * * This list must be freed using EINA_LIST_FREE / efreet_desktop_free * - * @param glob the pattern to match + * @param[in] glob the pattern to match * @return a list of desktops */ EAPI Eina_List *efreet_util_desktop_name_glob_list(const char *glob); @@ -101,7 +103,7 @@ EAPI Eina_List *efreet_util_desktop_name_glob_list(const char *glob); * * This list must be freed using EINA_LIST_FREE / efreet_desktop_free * - * @param glob the pattern to match + * @param[in] glob the pattern to match * @return a list of desktops */ EAPI Eina_List *efreet_util_desktop_exec_glob_list(const char *glob); @@ -111,7 +113,7 @@ EAPI Eina_List *efreet_util_desktop_exec_glob_list(const char *glob); * * This list must be freed using EINA_LIST_FREE / efreet_desktop_free * - * @param glob the pattern to match + * @param[in] glob the pattern to match * @return a list of desktops */ EAPI Eina_List *efreet_util_desktop_generic_name_glob_list(const char *glob); @@ -121,7 +123,7 @@ EAPI Eina_List *efreet_util_desktop_generic_name_glob_list(const char *glob); * * This list must be freed using EINA_LIST_FREE / efreet_desktop_free * - * @param glob the pattern to match + * @param[in] glob the pattern to match * @return a list of desktops */ EAPI Eina_List *efreet_util_desktop_comment_glob_list(const char *glob); @@ -140,7 +142,7 @@ EAPI Eina_List *efreet_util_desktop_categories_list(void); * * This list must be freed using EINA_LIST_FREE / efreet_desktop_free * - * @param category the category name + * @param[in] category the category name * @return a list of desktops */ EAPI Eina_List *efreet_util_desktop_category_list(const char *category); @@ -148,21 +150,12 @@ EAPI Eina_List *efreet_util_desktop_category_list(const char *category); /** * Returns a list of .menu files found in the various config dirs. + * * @return An eina list of menu file paths (const char *). This must be freed with EINA_LIST_FREE. */ EAPI Eina_List *efreet_util_menus_find(void); /** - * Find all known desktop environments - * This list must be freed using EINA_LIST_FREE - * @since 1.12 - * - * @return an Eina_List of desktop environments names (const char *) - */ -EAPI Eina_List *efreet_util_desktop_environments_list(void); - - -/** * @} */ #endif |