diff --git a/legacy/efreet/src/lib/efreet.c b/legacy/efreet/src/lib/efreet.c index 3f3e459bee..6a84352bef 100644 --- a/legacy/efreet/src/lib/efreet.c +++ b/legacy/efreet/src/lib/efreet.c @@ -223,7 +223,7 @@ efreet_parse_locale(void) /** * @internal - * @param env: The environment variable to grab + * @param env The environment variable to grab * @return Returns 1 if we parsed something of @a env, 0 otherwise * @brief Tries to parse the lang settings out of the given environment * variable @@ -275,9 +275,9 @@ efreet_parse_locale_setting(const char *env) /** * @internal - * @param buffer: The destination buffer - * @param size: The destination buffer size - * @param strs: The strings to concatenate together + * @param buffer The destination buffer + * @param size The destination buffer size + * @param strs The strings to concatenate together * @return Returns the size of the string in @a buffer * @brief Concatenates the strings in @a strs into the given @a buffer not * exceeding the given @a size. diff --git a/legacy/efreet/src/lib/efreet_base.c b/legacy/efreet/src/lib/efreet_base.c index b8651ef7ec..f3ae31b5a9 100644 --- a/legacy/efreet/src/lib/efreet_base.c +++ b/legacy/efreet/src/lib/efreet_base.c @@ -222,8 +222,8 @@ efreet_hostname_get(void) /** * @internal - * @param key: The environemnt key to lookup - * @param fallback: The fallback value to use + * @param key The environemnt key to lookup + * @param fallback The fallback value to use * @return Returns the directory related to the given key or the fallback * @brief This trys to determine the correct directory name given the * environment key @a key and fallbacks @a fallback. @@ -256,8 +256,8 @@ efreet_dir_get(const char *key, const char *fallback) /** * @internal - * @param key: The environment key to lookup - * @param fallback: The fallback value to use + * @param key The environment key to lookup + * @param fallback The fallback value to use * @return Returns a list of directories specified by the given key @a key * or from the list of fallbacks in @a fallback. * @brief Creates a list of directories as given in the environment key @a diff --git a/legacy/efreet/src/lib/efreet_desktop.c b/legacy/efreet/src/lib/efreet_desktop.c index 6d5348ab16..2919a7d465 100644 --- a/legacy/efreet/src/lib/efreet_desktop.c +++ b/legacy/efreet/src/lib/efreet_desktop.c @@ -183,7 +183,7 @@ efreet_desktop_shutdown(void) } /** - * @param file: The file to get the Efreet_Desktop from + * @param file The file to get the Efreet_Desktop from * @return Returns a reference to a cached Efreet_Desktop on success, NULL * on failure. This reference should not be freed. * @brief Gets a reference to an Efreet_Desktop structure representing the @@ -247,7 +247,7 @@ efreet_desktop_get(const char *file) } /** - * @param desktop: The Efreet_Desktop to ref + * @param desktop The Efreet_Desktop to ref * @return Returns the new reference count * @brief Increases reference count on desktop */ @@ -260,7 +260,7 @@ efreet_desktop_ref(Efreet_Desktop *desktop) } /** - * @param file: The file to create the Efreet_Desktop from + * @param file The file to create the Efreet_Desktop from * @return Returns a new empty_Efreet_Desktop on success, NULL on failure * @brief Creates a new empty Efreet_Desktop structure or NULL on failure */ @@ -281,7 +281,7 @@ efreet_desktop_empty_new(const char *file) } /** - * @param file: The file to create the Efreet_Desktop from + * @param file The file to create the Efreet_Desktop from * @return Returns a new Efreet_Desktop on success, NULL on failure * @brief Creates a new Efreet_Desktop structure initialized from the * contents of @a file or NULL on failure @@ -314,7 +314,7 @@ efreet_desktop_new(const char *file) } /** - * @param file: The file to create the Efreet_Desktop from + * @param file The file to create the Efreet_Desktop from * @return Returns a new Efreet_Desktop on success, NULL on failure * @brief Creates a new Efreet_Desktop structure initialized from the * contents of @a file or NULL on failure @@ -346,7 +346,7 @@ efreet_desktop_uncached_new(const char *file) } /** - * @param desktop: The desktop file to save + * @param desktop The desktop file to save * @return Returns 1 on success or 0 on failure * @brief Saves any changes made to @a desktop back to the file on the * filesystem @@ -406,8 +406,8 @@ efreet_desktop_save(Efreet_Desktop *desktop) } /** - * @param desktop: The desktop file to save - * @param file: The filename to save as + * @param desktop The desktop file to save + * @param file The filename to save as * @return Returns 1 on success or 0 on failure * @brief Saves @a desktop to @a file */ @@ -426,7 +426,7 @@ efreet_desktop_save_as(Efreet_Desktop *desktop, const char *file) } /** - * @param desktop: The Efreet_Desktop to work with + * @param desktop The Efreet_Desktop to work with * @return Returns no value * @brief Frees the Efreet_Desktop structure and all of it's data */ @@ -492,7 +492,7 @@ efreet_desktop_free(Efreet_Desktop *desktop) } /** - * @param environment: the environment name + * @param environment the environment name * @brief sets the global desktop environment name */ EAPI void @@ -504,7 +504,7 @@ efreet_desktop_environment_set(const char *environment) } /** - * @return environment: the environment name + * @return environment the environment name * @brief sets the global desktop environment name */ EAPI const char * @@ -514,7 +514,7 @@ efreet_desktop_environment_get(void) } /** - * @param desktop: The desktop to work with + * @param desktop The desktop to work with * @return Returns the number of categories assigned to this desktop * @brief Retrieves the number of categories the given @a desktop belongs * too @@ -527,8 +527,8 @@ efreet_desktop_category_count_get(Efreet_Desktop *desktop) } /** - * @param desktop: the desktop - * @param category: the category name + * @param desktop the desktop + * @param category the category name * @brief add a category to a desktop */ EAPI void @@ -544,8 +544,8 @@ efreet_desktop_category_add(Efreet_Desktop *desktop, const char *category) } /** - * @param desktop: the desktop - * @param category: the category name + * @param desktop the desktop + * @param category the category name * @brief removes a category from a desktop * @return 1 if the desktop had his category listed, 0 otherwise */ @@ -569,10 +569,10 @@ efreet_desktop_category_del(Efreet_Desktop *desktop, const char *category) } /** - * @param type: The type to add to the list of matching types - * @param parse_func: a function to parse out custom fields - * @param save_func: a function to save data returned from @a parse_func - * @param free_func: a function to free data returned from @a parse_func + * @param type The type to add to the list of matching types + * @param parse_func a function to parse out custom fields + * @param save_func a function to save data returned from @a parse_func + * @param free_func a function to free data returned from @a parse_func * @return Returns the id of the new type * @brief Adds the given type to the list of types in the system */ @@ -696,7 +696,7 @@ efreet_desktop_type_data_get(Efreet_Desktop *desktop) } /** - * @param string: the raw string list + * @param string the raw string list * @return an Eina_List of ecore string's * @brief Parse ';' separate list of strings according to the desktop spec */ @@ -736,7 +736,7 @@ efreet_desktop_string_list_parse(const char *string) } /** - * @param list: Eina_List with strings + * @param list Eina_List with strings * @return a raw string list * @brief Create a ';' separate list of strings according to the desktop spec */ @@ -856,7 +856,7 @@ error: /** * @internal - * @param desktop: The desktop to check + * @param desktop The desktop to check * @return Returns 1 if the cache is still valid, 0 otherwise * @brief This will check if the desktop cache is still valid. */ @@ -874,7 +874,7 @@ efreet_desktop_cache_check(Efreet_Desktop *desktop) /** * @internal - * @param desktop: The desktop to fill + * @param desktop The desktop to fill * @return Returns 1 on success, 0 on failure * @brief initialize an Efreet_Desktop from the contents of @a file */ @@ -937,7 +937,7 @@ efreet_desktop_read(Efreet_Desktop *desktop) /** * @internal - * @param type_str: the type as a string + * @param type_str the type as a string * @return the parsed type * @brief parse the type string into an Efreet_Desktop_Type */ @@ -972,8 +972,8 @@ efreet_desktop_type_info_free(Efreet_Desktop_Type_Info *info) /** * @internal - * @param desktop: the Efreet_Desktop to store parsed fields in - * @param ini: the Efreet_Ini to parse fields from + * @param desktop the Efreet_Desktop to store parsed fields in + * @param ini the Efreet_Ini to parse fields from * @return No value * @brief Parse application specific desktop fields */ @@ -1007,8 +1007,8 @@ efreet_desktop_application_fields_parse(Efreet_Desktop *desktop, Efreet_Ini *ini /** * @internal - * @param desktop: the Efreet_Desktop to save fields from - * @param ini: the Efreet_Ini to save fields to + * @param desktop the Efreet_Desktop to save fields from + * @param ini the Efreet_Ini to save fields to * @return Returns no value * @brief Save application specific desktop fields */ @@ -1055,8 +1055,8 @@ efreet_desktop_application_fields_save(Efreet_Desktop *desktop, Efreet_Ini *ini) /** * @internal - * @param desktop: the Efreet_Desktop to store parsed fields in - * @param ini: the Efreet_Ini to parse fields from + * @param desktop the Efreet_Desktop to store parsed fields in + * @param ini the Efreet_Ini to parse fields from * @return Returns no value * @brief Parse link specific desktop fields */ @@ -1072,8 +1072,8 @@ efreet_desktop_link_fields_parse(Efreet_Desktop *desktop, Efreet_Ini *ini) /** * @internal - * @param desktop: the Efreet_Desktop to save fields from - * @param ini: the Efreet_Ini to save fields in + * @param desktop the Efreet_Desktop to save fields from + * @param ini the Efreet_Ini to save fields in * @return Returns no value * @brief Save link specific desktop fields */ @@ -1085,8 +1085,8 @@ efreet_desktop_link_fields_save(Efreet_Desktop *desktop, Efreet_Ini *ini) /** * @internal - * @param desktop: the Efreet_Desktop to store parsed fields in - * @param ini: the Efreet_Ini to parse fields from + * @param desktop the Efreet_Desktop to store parsed fields in + * @param ini the Efreet_Ini to parse fields from * @return 1 if parsed successfully, 0 otherwise * @brief Parse desktop fields that all types can include */ @@ -1128,8 +1128,8 @@ efreet_desktop_generic_fields_parse(Efreet_Desktop *desktop, Efreet_Ini *ini) /** * @internal - * @param desktop: the Efreet_Desktop to save fields from - * @param ini: the Efreet_Ini to save fields to + * @param desktop the Efreet_Desktop to save fields from + * @param ini the Efreet_Ini to save fields to * @return Returns nothing * @brief Save desktop fields that all types can include */ @@ -1176,8 +1176,8 @@ efreet_desktop_generic_fields_save(Efreet_Desktop *desktop, Efreet_Ini *ini) /** * @internal - * @param node: The node to work with - * @param desktop: The desktop file to work with + * @param node The node to work with + * @param desktop The desktop file to work with * @return Returns always true, to be used in eina_hash_foreach() * @brief Parses out an X- key from @a node and stores in @a desktop */ @@ -1199,8 +1199,8 @@ efreet_desktop_x_fields_parse(const Eina_Hash *hash __UNUSED__, const void *key, /** * @internal - * @param node: The node to work with - * @param ini: The ini file to work with + * @param node The node to work with + * @param ini The ini file to work with * @return Returns no value * @brief Stores an X- key from @a node and stores in @a ini */ @@ -1216,7 +1216,7 @@ efreet_desktop_x_fields_save(const Eina_Hash *hash __UNUSED__, const void *key, /** * @internal - * @param ini: The Efreet_Ini to parse values from + * @param ini The Efreet_Ini to parse values from * @return 1 if desktop should be included in current environement, 0 otherwise * @brief Determines if a desktop should be included in the current environment, * based on the values of the OnlyShowIn and NotShowIn fields diff --git a/legacy/efreet/src/lib/efreet_desktop_command.c b/legacy/efreet/src/lib/efreet_desktop_command.c index 5eab031462..50432b7dd4 100644 --- a/legacy/efreet/src/lib/efreet_desktop_command.c +++ b/legacy/efreet/src/lib/efreet_desktop_command.c @@ -141,9 +141,9 @@ static char *efreet_string_append_char(char *dest, int *size, /** - * @param desktop: The desktop file to work with - * @param files: The files to be substituted into the exec line - * @param data: The data pointer to pass + * @param desktop The desktop file to work with + * @param files The files to be substituted into the exec line + * @param data The data pointer to pass * @return Returns the Ecore_Exce for @a desktop * @brief Parses the @a desktop exec line and returns an Ecore_Exe. */ @@ -154,11 +154,11 @@ efreet_desktop_exec(Efreet_Desktop *desktop, Eina_List *files, void *data) } /** - * @param desktop: the desktop entry - * @param files: an eina list of file names to execute, as either absolute paths, + * @param desktop the desktop entry + * @param files an eina list of file names to execute, as either absolute paths, * relative paths, or uris - * @param func: a callback to call for each prepared command line - * @param data: user data passed to the callback + * @param func a callback to call for each prepared command line + * @param data user data passed to the callback * @return Returns the return value of @p func on success or NULL on failure * @brief Get a command to use to execute a desktop entry. */ @@ -170,8 +170,8 @@ efreet_desktop_command_get(Efreet_Desktop *desktop, Eina_List *files, } /** - * @param desktop: the desktop entry - * @param files an eina list of local files, as absolute paths, local paths, or file:// uris (or NULL to get exec string with no files appended) + * @param desktop the desktop entry + * @param files an eina list of local files, as absolute paths, local paths, or file// uris (or NULL to get exec string with no files appended) * @return Returns an eina list of exec strings * @brief Get the command to use to execute a desktop entry * @@ -217,12 +217,12 @@ efreet_desktop_command_local_get(Efreet_Desktop *desktop, Eina_List *files) } /** - * @param desktop: the desktop entry - * @param files: an eina list of file names to execute, as either absolute paths, + * @param desktop the desktop entry + * @param files an eina list of file names to execute, as either absolute paths, * relative paths, or uris - * @param cb_command: a callback to call for each prepared command line - * @param cb_progress: a callback to get progress for the downloads - * @param data: user data passed to the callback + * @param cb_command a callback to call for each prepared command line + * @param cb_progress a callback to get progress for the downloads + * @param data user data passed to the callback * @return Returns 1 on success or 0 on failure * @brief Get a command to use to execute a desktop entry, and receive progress * updates for downloading of remote URI's passed in. @@ -368,7 +368,7 @@ efreet_desktop_command_execs_process(Efreet_Desktop_Command *command, Eina_List * processed filename information. The callback passed in to * efreet_desktop_command_get is called for each exec string created. * - * @param command: the command to build + * @param command the command to build * @return a list of executable strings */ static Eina_List * @@ -653,8 +653,8 @@ efreet_desktop_command_append_icon(char *dest, int *size, int *len, } /** - * @param command: the Efreet_Desktop_Comand that this file is for - * @param file: the filname as either an absolute path, relative path, or URI + * @param command the Efreet_Desktop_Comand that this file is for + * @param file the filname as either an absolute path, relative path, or URI */ static Efreet_Desktop_Command_File * efreet_desktop_command_file_process(Efreet_Desktop_Command *command, const char *file) @@ -740,7 +740,7 @@ error: /** * @brief Find the local path portion of a file uri. - * @param uri: a uri beginning with "file:" + * @param uri a uri beginning with "file" * @return the location of the path portion of the uri, * or NULL if the file is not on this machine */ @@ -853,7 +853,7 @@ efreet_desktop_cb_download_progress(void *data, /** * @brief Build an absolute path from an absolute or relative one. - * @param path: an absolute or relative path + * @param path an absolute or relative path * @return an allocated absolute path (must be freed) */ static char * diff --git a/legacy/efreet/src/lib/efreet_icon.c b/legacy/efreet/src/lib/efreet_icon.c index 54834b1039..6224e794d1 100644 --- a/legacy/efreet/src/lib/efreet_icon.c +++ b/legacy/efreet/src/lib/efreet_icon.c @@ -199,8 +199,8 @@ efreet_icon_shutdown(void) } /** - * @return Returns the user icon directory - * @brief Returns the user icon directory + * @return Returns the deprecated user icon directory + * @brief Returns the deprecated user icon directory */ EAPI const char * efreet_icon_deprecated_user_dir_get(void) @@ -221,6 +221,10 @@ efreet_icon_deprecated_user_dir_get(void) return efreet_icon_deprecated_user_dir; } +/** + * @return Returns the user icon directory + * @brief Returns the user icon directory + */ EAPI const char * efreet_icon_user_dir_get(void) { @@ -241,7 +245,7 @@ efreet_icon_user_dir_get(void) } /** - * @param ext: The extension to add to the list of checked extensions + * @param ext The extension to add to the list of checked extensions * @return Returns no value. * @brief Adds the given extension to the list of possible icon extensions */ @@ -326,7 +330,7 @@ efreet_icon_theme_list_get(void) } /** - * @param theme_name: The theme to look for + * @param theme_name The theme to look for * @return Returns the icon theme related to the given theme name or NULL if * none exists. * @brief Tries to get the icon theme structure for the given theme name @@ -355,7 +359,7 @@ efreet_icon_theme_find(const char *theme_name) /** * @internal - * @param icon: The icon name to strip extension + * @param icon The icon name to strip extension * @return Extension removed if in list of extensions, else untouched. * @brief Removes extension from icon name if in list of extensions. */ @@ -392,7 +396,7 @@ efreet_icon_remove_extension(const char *icon) #ifndef ICON_CACHE /** * @internal - * @param theme_name: The icon theme to look for + * @param theme_name The icon theme to look for * @return Returns the Efreet_Icon_Theme structure representing this theme * or a new blank theme if not found * @brief Retrieves a theme, or creates a blank one if not found. @@ -416,8 +420,8 @@ efreet_icon_find_theme_check(const char *theme_name) #endif /** - * @param theme_name: The icon theme to look for - * @param icon: The icon to look for + * @param theme_name The icon theme to look for + * @param icon The icon to look for * @param size; The icon size to look for * @return Returns the path to the given icon or NULL if none found * @brief Retrives the path to the given icon. @@ -482,8 +486,8 @@ efreet_icon_path_find(const char *theme_name, const char *icon, unsigned int siz } /** - * @param theme_name: The icon theme to look for - * @param icons: List of icons to look for + * @param theme_name The icon theme to look for + * @param icons List of icons to look for * @param size; The icon size to look for * @return Returns the path representing first found icon or * NULL if none of the icons are found @@ -587,9 +591,9 @@ efreet_icon_list_find(const char *theme_name, Eina_List *icons, } /** - * @param theme_name: The icon theme to look for - * @param icon: The icon to look for - * @param size: The icon size to look for + * @param theme_name The icon theme to look for + * @param icon The icon to look for + * @param size The icon size to look for * @return Returns the Efreet_Icon structure representing this icon or NULL * if the icon is not found * @brief Retrieves all of the information about the given icon. @@ -614,9 +618,9 @@ efreet_icon_find(const char *theme_name, const char *icon, unsigned int size) #ifndef ICON_CACHE /** * @internal - * @param theme: The theme to search in - * @param icon: The icon to search for - * @param size: The size to search for + * @param theme The theme to search in + * @param icon The icon to search for + * @param size The size to search for * @return Returns the icon matching the given information or NULL if no * icon found * @brief Scans inheriting themes for the given icon @@ -660,9 +664,9 @@ efreet_icon_find_fallback(Efreet_Icon_Theme *theme, /** * @internal - * @param theme: The theme to search in - * @param icon: The icon to search for - * @param size: The size to search for + * @param theme The theme to search in + * @param icon The icon to search for + * @param size The size to search for * @return Returns the icon matching the given information or NULL if no * icon found * @brief Scans the theme and any inheriting themes for the given icon @@ -697,9 +701,9 @@ efreet_icon_find_helper(Efreet_Icon_Theme *theme, /** * @internal - * @param theme: The theme to search in - * @param icons: The icons to search for - * @param size: The size to search for + * @param theme The theme to search in + * @param icons The icons to search for + * @param size The size to search for * @return Returns the icon matching the given information or NULL if no * icon found * @brief Scans inheriting themes for the given icons @@ -745,9 +749,9 @@ efreet_icon_list_find_fallback(Efreet_Icon_Theme *theme, /** * @internal - * @param theme: The theme to search in - * @param icons: The icons to search for - * @param size: The size to search for + * @param theme The theme to search in + * @param icons The icons to search for + * @param size The size to search for * @return Returns the icon matching the given information or NULL if no * icon found * @brief Scans the theme and any inheriting themes for the given icons @@ -787,9 +791,9 @@ efreet_icon_list_find_helper(Efreet_Icon_Theme *theme, /** * @internal - * @param theme: The icon theme to look in - * @param icon_name: The icon name to look for - * @param size: The icon size to look for + * @param theme The icon theme to look in + * @param icon_name The icon name to look for + * @param size The icon size to look for * @return Returns the path for the theme/icon/size combo or NULL if * none found * @brief Looks for the @a icon in the @a theme for the @a size given. @@ -850,9 +854,9 @@ efreet_icon_lookup_icon(Efreet_Icon_Theme *theme, const char *icon_name, /** * @internal - * @param theme: The theme to use - * @param dir: The theme directory to look in - * @param icon_name: The icon name to look for + * @param theme The theme to use + * @param dir The theme directory to look in + * @param icon_name The icon name to look for * @return Returns the icon cloest matching the given information or NULL if * none found * @brief Tries to find the file closest matching the given icon @@ -881,8 +885,8 @@ efreet_icon_lookup_directory(Efreet_Icon_Theme *theme, /** * @internal - * @param dir: The theme directory to work with - * @param size: The size to check + * @param dir The theme directory to work with + * @param size The size to check * @return Returns true if the size matches for the given directory, 0 * otherwise * @brief Checks if the size matches for the given directory or not @@ -903,8 +907,8 @@ efreet_icon_directory_size_match(Efreet_Icon_Theme_Directory *dir, /** * @internal - * @param dir: The directory to work with - * @param size: The size to check for + * @param dir The directory to work with + * @param size The size to check for * @return Returns the distance this size is away from the desired size * @brief Returns the distance the given size is away from the desired size */ @@ -937,7 +941,7 @@ efreet_icon_directory_size_distance(Efreet_Icon_Theme_Directory *dir, /** * @internal - * @param icon_name: The icon name to look for + * @param icon_name The icon name to look for * @return Returns the Efreet_Icon for the given name or NULL if none found * @brief Looks for the un-themed icon in the base directories */ @@ -1004,8 +1008,8 @@ efreet_icon_fallback_icon(const char *icon_name) /** * @internal - * @param dir: The directory to scan - * @param icon_name: The icon to look for + * @param dir The directory to scan + * @param icon_name The icon to look for * @return Returns the icon for the given name or NULL on failure * @brief Scans the given @a dir for the given @a icon_name returning the * Efreet_icon if found, NULL otherwise. @@ -1053,9 +1057,9 @@ efreet_icon_fallback_dir_scan(const char *dir, const char *icon_name) /** * @internal - * @param theme: The theme to work with - * @param dir: The theme directory to work with - * @param path: The partial path to use + * @param theme The theme to work with + * @param dir The theme directory to work with + * @param path The partial path to use * @return Returns no value * @brief Caches the icons in the given theme directory path at the given * size @@ -1139,7 +1143,7 @@ efreet_icon_new(const char *path) } /** - * @param icon: The Efreet_Icon to cleanup + * @param icon The Efreet_Icon to cleanup * @return Returns no value. * @brief Free's the given icon and all its internal data. */ @@ -1160,8 +1164,8 @@ efreet_icon_free(Efreet_Icon *icon) /** * @internal - * @param icon: The icon to populate - * @param file: The file to populate from + * @param icon The icon to populate + * @param file The file to populate from * @return Returns no value * @brief Tries to populate the icon information from the given file */ @@ -1282,7 +1286,7 @@ efreet_icon_theme_new(void) /** * @internal - * @param theme: The theme to free + * @param theme The theme to free * @return Returns no value * @brief Frees up the @a theme structure. */ @@ -1306,8 +1310,8 @@ efreet_icon_theme_free(Efreet_Icon_Theme *theme) /** * @internal - * @param theme: The theme to work with - * @param path: The path to add + * @param theme The theme to work with + * @param path The path to add * @return Returns no value * @brief This will correctly add the given path to the list of theme paths. * @Note Assumes you've already verified that @a path is a valid directory. @@ -1360,8 +1364,8 @@ efreet_icon_theme_cache_check(Efreet_Icon_Theme *theme) /** * @internal - * @param theme: The icon theme to check - * @param dir: The directory to check + * @param theme The icon theme to check + * @param dir The directory to check * @return Returns 1 if the cache is still valid, 0 otherwise * @brief This will check if the theme cache is still valid. If it isn't the * cache will be invalided and 0 returned. @@ -1399,7 +1403,7 @@ efreet_icon_theme_cache_check_dir(Efreet_Icon_Theme *theme, const char *dir) /** * @internal - * @param theme_name: The theme to scan for + * @param theme_name The theme to scan for * @return Returns no value * @brief Scans the theme directories. If @a theme_name is NULL it will load * up all theme data. If @a theme_name is not NULL it will look for that @@ -1434,8 +1438,8 @@ efreet_icon_theme_dir_scan_all(const char *theme_name) /** * @internal - * @param search_dir: The directory to scan - * @param theme_name: Scan for this specific theme, set to NULL to find all + * @param search_dir The directory to scan + * @param theme_name Scan for this specific theme, set to NULL to find all * themes. * @return Returns no value * @brief Scans the given directory and adds non-hidden icon themes to the @@ -1498,8 +1502,8 @@ error: /** * @internal - * @param theme: The theme to set the values into - * @param path: The path to the index.theme file for this theme + * @param theme The theme to set the values into + * @param path The path to the index.theme file for this theme * @return Returns no value * @brief This will load up the theme with the data in the index.theme file */ @@ -1593,8 +1597,8 @@ error: /** * @internal - * @param ini: The ini file with information on this directory - * @param name: The name of the directory + * @param ini The ini file with information on this directory + * @param name The name of the directory * @return Returns a new Efreet_Icon_Theme_Directory based on the * information in @a ini. * @brief Creates and initialises an icon theme directory from the given ini @@ -1671,7 +1675,7 @@ efreet_icon_theme_directory_new(Efreet_Ini *ini, const char *name) /** * @internal - * @param dir: The Efreet_Icon_Theme_Directory to free + * @param dir The Efreet_Icon_Theme_Directory to free * @return Returns no value * @brief Frees the given directory @a dir */ diff --git a/legacy/efreet/src/lib/efreet_icon.h b/legacy/efreet/src/lib/efreet_icon.h index b5e9894a5d..765a72bb91 100644 --- a/legacy/efreet/src/lib/efreet_icon.h +++ b/legacy/efreet/src/lib/efreet_icon.h @@ -130,12 +130,12 @@ struct Efreet_Icon }; /** - * Efreet_Point + * Efreet_Icon_Point */ typedef struct Efreet_Icon_Point Efreet_Icon_Point; /** - * Efreet_Point + * Efreet_Icon_Point * @brief Stores an x, y point. */ struct Efreet_Icon_Point diff --git a/legacy/efreet/src/lib/efreet_ini.c b/legacy/efreet/src/lib/efreet_ini.c index a46c168f95..b65dfe9f09 100644 --- a/legacy/efreet/src/lib/efreet_ini.c +++ b/legacy/efreet/src/lib/efreet_ini.c @@ -76,7 +76,7 @@ efreet_ini_shutdown(void) } /** - * @param file: The file to parse + * @param file The file to parse * @return Returns a new Efreet_Ini structure initialized with the contents * of @a file, or NULL on memory allocation failure * @brief Creates and initializes a new Ini structure with the contents of @@ -289,7 +289,7 @@ next_line: } /** - * @param ini: The Efreet_Ini to work with + * @param ini The Efreet_Ini to work with * @return Returns no value * @brief Frees the given Efree_Ini structure. */ @@ -303,8 +303,8 @@ efreet_ini_free(Efreet_Ini *ini) } /** - * @param ini: The Efreet_Ini to work with - * @param file: The file to load + * @param ini The Efreet_Ini to work with + * @param file The file to load * @return Returns no value * @brief Saves the given Efree_Ini structure. */ @@ -331,8 +331,8 @@ efreet_ini_save(Efreet_Ini *ini, const char *file) } /** - * @param ini: The Efreet_Ini to work with - * @param section: The section of the ini file we want to get values from + * @param ini The Efreet_Ini to work with + * @param section The section of the ini file we want to get values from * @return Returns 1 if the section exists, otherwise 0 * @brief Sets the current working section of the ini file to @a section */ @@ -346,8 +346,8 @@ efreet_ini_section_set(Efreet_Ini *ini, const char *section) } /** - * @param ini: The Efreet_Ini to work with - * @param section: The section of the ini file we want to add + * @param ini The Efreet_Ini to work with + * @param section The section of the ini file we want to add * @return Returns no value * @brief Adds a new working section of the ini file to @a section */ @@ -367,8 +367,8 @@ efreet_ini_section_add(Efreet_Ini *ini, const char *section) } /** - * @param ini: The Efree_Ini to work with - * @param key: The key to lookup + * @param ini The Efree_Ini to work with + * @param key The key to lookup * @return Returns the string associated with the given key or NULL if not * found. * @brief Retrieves the value for the given key or NULL if none found. @@ -382,9 +382,9 @@ efreet_ini_string_get(Efreet_Ini *ini, const char *key) } /** - * @param ini: The Efree_Ini to work with - * @param key: The key to use - * @param value: The value to set + * @param ini The Efree_Ini to work with + * @param key The key to use + * @param value The value to set * @return Returns no value * @brief Sets the value for the given key */ @@ -398,8 +398,8 @@ efreet_ini_string_set(Efreet_Ini *ini, const char *key, const char *value) } /** - * @param ini: The Efree_Ini to work with - * @param key: The key to lookup + * @param ini The Efree_Ini to work with + * @param key The key to lookup * @return Returns the integer associated with the given key or -1 if not * found. * @brief Retrieves the value for the given key or -1 if none found. @@ -418,9 +418,9 @@ efreet_ini_int_get(Efreet_Ini *ini, const char *key) } /** - * @param ini: The Efree_Ini to work with - * @param key: The key to use - * @param value: The value to set + * @param ini The Efree_Ini to work with + * @param key The key to use + * @param value The value to set * @return Returns no value * @brief Sets the value for the given key */ @@ -436,8 +436,8 @@ efreet_ini_int_set(Efreet_Ini *ini, const char *key, int value) } /** - * @param ini: The Efree_Ini to work with - * @param key: The key to lookup + * @param ini The Efree_Ini to work with + * @param key The key to lookup * @return Returns the double associated with the given key or -1 if not * found. * @brief Retrieves the value for the given key or -1 if none found. @@ -456,9 +456,9 @@ efreet_ini_double_get(Efreet_Ini *ini, const char *key) } /** - * @param ini: The Efree_Ini to work with - * @param key: The key to use - * @param value: The value to set + * @param ini The Efree_Ini to work with + * @param key The key to use + * @param value The value to set * @return Returns no value * @brief Sets the value for the given key */ @@ -478,8 +478,8 @@ efreet_ini_double_set(Efreet_Ini *ini, const char *key, double value) } /** - * @param ini: The ini struct to work with - * @param key: The key to search for + * @param ini The ini struct to work with + * @param key The key to search for * @return Returns 1 if the boolean is true, 0 otherwise * @brief Retrieves the boolean value at key @a key from the ini @a ini */ @@ -497,9 +497,9 @@ efreet_ini_boolean_get(Efreet_Ini *ini, const char *key) } /** - * @param ini: The ini struct to work with - * @param key: The key to use - * @param value: The value to set + * @param ini The ini struct to work with + * @param key The key to use + * @param value The value to set * @return Returns no value * @brief Sets the value for the given key */ @@ -513,8 +513,8 @@ efreet_ini_boolean_set(Efreet_Ini *ini, const char *key, unsigned int value) } /** - * @param ini: The ini struct to work with - * @param key: The key to search for + * @param ini The ini struct to work with + * @param key The key to search for * @return Returns the utf8 encoded string associated with @a key, or NULL * if none found * @brief Retrieves the utf8 encoded string associated with @a key in the current locale or NULL if none found @@ -576,9 +576,9 @@ efreet_ini_localestring_get(Efreet_Ini *ini, const char *key) } /** - * @param ini: The ini struct to work with - * @param key: The key to use - * @param value: The value to set + * @param ini The ini struct to work with + * @param key The key to use + * @param value The value to set * @return Returns no value * @brief Sets the value for the given key */ @@ -617,8 +617,8 @@ efreet_ini_localestring_set(Efreet_Ini *ini, const char *key, const char *value) } /** - * @param ini: The ini struct to work with - * @param key: The key to remove + * @param ini The ini struct to work with + * @param key The key to remove * @return Returns no value * @brief Remove the given key from the ini struct */ diff --git a/legacy/efreet/src/lib/efreet_menu.c b/legacy/efreet/src/lib/efreet_menu.c index f6674e3c22..109f8feab3 100644 --- a/legacy/efreet/src/lib/efreet_menu.c +++ b/legacy/efreet/src/lib/efreet_menu.c @@ -639,6 +639,13 @@ efreet_menu_new(const char *name) return menu; } +/** + * @brief Override which file is used for menu creation + * @param file The file to use for menu creation + * + * This file is only used if it exists, else the standard files will be used + * for the menu. + */ EAPI void efreet_menu_file_set(const char *file) { @@ -688,7 +695,7 @@ efreet_menu_get(void) } /** - * @param path: The path of the menu to load + * @param path The path of the menu to load * @return Returns the Efreet_Menu_Internal representation on success or NULL on * failure * @brief Parses the given .menu file and creates the menu representation @@ -766,8 +773,8 @@ efreet_menu_parse(const char *path) } /** - * @param menu: The menu to work with - * @param path: The path where the menu should be saved + * @param menu The menu to work with + * @param path The path where the menu should be saved * @return Returns 1 on success, 0 on failure * @brief Saves the menu to file */ @@ -886,9 +893,9 @@ efreet_menu_save_indent(FILE *f, int indent) } /** - * @param menu: The menu to work with - * @param desktop: The desktop to insert - * @param pos: The position to place the new desktop + * @param menu The menu to work with + * @param desktop The desktop to insert + * @param pos The position to place the new desktop * @return Returns 1 on success, 0 on failure * @brief Insert a desktop element in a menu structure. Only accepts desktop files * in default directories. @@ -922,8 +929,8 @@ efreet_menu_desktop_insert(Efreet_Menu *menu, Efreet_Desktop *desktop, int pos) } /** - * @param menu: The menu to work with - * @param desktop: The desktop to remove + * @param menu The menu to work with + * @param desktop The desktop to remove * @return Returns 1 on success, 0 on failure * @brief Remove a desktop element in a menu structure. Only accepts desktop files * in default directories. @@ -948,9 +955,9 @@ efreet_menu_desktop_remove(Efreet_Menu *menu, Efreet_Desktop *desktop) } /** - * @param menu: The menu to work with - * @param menu: The menu to work with - * @param indent: The indent level to print the menu at + * @param menu The menu to work with + * @param menu The menu to work with + * @param indent The indent level to print the menu at * @return Returns no value * @brief Dumps the contents of the menu to the command line */ @@ -989,9 +996,9 @@ efreet_menu_dump(Efreet_Menu *menu, const char *indent) } /** - * @param user_dir: The user directory to work with - * @param system_dirs: The system directories to work with - * @param suffix: The path suffix to add + * @param user_dir The user directory to work with + * @param system_dirs The system directories to work with + * @param suffix The path suffix to add * @return Returns the list of directories * @brief Creates the list of directories based on the user * dir, system dirs and given suffix. @@ -1041,7 +1048,7 @@ efreet_menu_internal_new(void) } /** - * @param menu: The menu to free + * @param menu The menu to free * @return Returns no value * @brief Frees up the given menu structure */ @@ -1093,8 +1100,8 @@ efreet_menu_prefix_get(void) /** * @internal - * @param menu: The menu to populate - * @param xml: The xml dom tree to populate from + * @param menu The menu to populate + * @param xml The xml dom tree to populate from * @return Returns 1 if this XML tree is valid, 0 otherwise * @brief Populates the given menu from the given xml structure * @@ -1129,8 +1136,8 @@ efreet_menu_handle_menu(Efreet_Menu_Internal *internal, Efreet_Xml *xml) /** * @internal - * @param parent: The parent Menu - * @param xml: The xml that defines the menu + * @param parent The parent Menu + * @param xml The xml that defines the menu * @return Returns 1 on success or 0 on failure * @brief Handles the sub-menu nodes of the XML file */ @@ -1168,8 +1175,8 @@ efreet_menu_handle_sub_menu(Efreet_Menu_Internal *parent, Efreet_Xml *xml) /** * @internal - * @param parent: The parent menu - * @param xml: The xml tree + * @param parent The parent menu + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the AppDir tag */ @@ -1204,8 +1211,8 @@ efreet_menu_handle_app_dir(Efreet_Menu_Internal *parent, Efreet_Xml *xml) /** * @internal - * @param parent: The parent menu - * @param xml: UNUSED + * @param parent The parent menu + * @param xml UNUSED * @return Returns 1 on success or 0 on failure * @brief Handles the DefaultAppDirs */ @@ -1244,8 +1251,8 @@ efreet_menu_handle_default_app_dirs(Efreet_Menu_Internal *parent, Efreet_Xml *xm /** * @internal - * @param parent: The parent menu - * @param xml: The xml tree + * @param parent The parent menu + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the DirectoryDir tag */ @@ -1274,8 +1281,8 @@ efreet_menu_handle_directory_dir(Efreet_Menu_Internal *parent, Efreet_Xml *xml) /** * @internal - * @param parent: The parent menu - * @param xml: UNUSED + * @param parent The parent menu + * @param xml UNUSED * @return Returns 1 on success or 0 on failure * @brief Handles the DefaultDirectoryDirs tag */ @@ -1302,8 +1309,8 @@ efreet_menu_handle_default_directory_dirs(Efreet_Menu_Internal *parent, Efreet_X /** * @internal - * @param parent: The parent Menu - * @param xml: The xml to work with + * @param parent The parent Menu + * @param xml The xml to work with * @return Returns 1 on success or 0 on failure * @brief Sets the menu name from the given XML fragment. */ @@ -1327,8 +1334,8 @@ efreet_menu_handle_name(Efreet_Menu_Internal *parent, Efreet_Xml *xml) /** * @internal - * @param parent: The parent menu - * @param xml: The xml tree + * @param parent The parent menu + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the Directory tag * @@ -1348,8 +1355,8 @@ efreet_menu_handle_directory(Efreet_Menu_Internal *parent, Efreet_Xml *xml) /** * @internal - * @param parent: The parent menu - * @param xml: The xml tree + * @param parent The parent menu + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the OnlyUnallocated tag */ @@ -1369,8 +1376,8 @@ efreet_menu_handle_only_unallocated(Efreet_Menu_Internal *parent, Efreet_Xml *xm /** * @internal - * @param parent: The parent menu - * @param xml: The xml tree + * @param parent The parent menu + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the NotOnlyUnallocated tag */ @@ -1390,8 +1397,8 @@ efreet_menu_handle_not_only_unallocated(Efreet_Menu_Internal *parent, Efreet_Xml /** * @internal - * @param parent: The parent menu - * @param xml: The xml tree + * @param parent The parent menu + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the Deleted tag */ @@ -1411,8 +1418,8 @@ efreet_menu_handle_deleted(Efreet_Menu_Internal *parent, Efreet_Xml *xml) /** * @internal - * @param parent: The parent menu - * @param xml: The xml tree + * @param parent The parent menu + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the NotDeleted tag */ @@ -1432,8 +1439,8 @@ efreet_menu_handle_not_deleted(Efreet_Menu_Internal *parent, Efreet_Xml *xml) /** * @internal - * @param parent: The parent menu - * @param xml: The XML tree to work with + * @param parent The parent menu + * @param xml The XML tree to work with * @return Returns 1 on success or 0 on failure * @brief Handles parsing the Include tag and all subtags */ @@ -1446,8 +1453,8 @@ efreet_menu_handle_include(Efreet_Menu_Internal *parent, Efreet_Xml *xml) /** * @internal - * @param parent: The parent menu - * @param xml: The xml tree + * @param parent The parent menu + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the Exclude tag and all subtags */ @@ -1460,8 +1467,8 @@ efreet_menu_handle_exclude(Efreet_Menu_Internal *parent, Efreet_Xml *xml) /** * @internal - * @param op: The filter operation - * @param xml: The xml tree + * @param op The filter operation + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the Filename tag */ @@ -1477,8 +1484,8 @@ efreet_menu_handle_filename(Efreet_Menu_Filter_Op *op, Efreet_Xml *xml) /** * @internal - * @param op: The filter operation - * @param xml: The xml tree + * @param op The filter operation + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the Category tag */ @@ -1495,8 +1502,8 @@ efreet_menu_handle_category(Efreet_Menu_Filter_Op *op, Efreet_Xml *xml) /** * @internal - * @param op: The filter operation - * @param xml: The xml tree + * @param op The filter operation + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the All tag and all subtags */ @@ -1512,8 +1519,8 @@ efreet_menu_handle_all(Efreet_Menu_Filter_Op *op, Efreet_Xml *xml) /** * @internal - * @param op: The filter operation - * @param xml: The xml tree + * @param op The filter operation + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the And tag and all subtags */ @@ -1528,8 +1535,8 @@ efreet_menu_handle_and(Efreet_Menu_Filter_Op *op, Efreet_Xml *xml) /** * @internal - * @param op: The filter operation - * @param xml: The xml tree + * @param op The filter operation + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the Or tag and all subtags */ @@ -1544,8 +1551,8 @@ efreet_menu_handle_or(Efreet_Menu_Filter_Op *op, Efreet_Xml *xml) /** * @internal - * @param op: The filter operation - * @param xml: The xml tree + * @param op The filter operation + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the Not tag and all subtags */ @@ -1560,8 +1567,8 @@ efreet_menu_handle_not(Efreet_Menu_Filter_Op *op, Efreet_Xml *xml) /** * @internal - * @param parent: The parent menu - * @param xml: The xml tree + * @param parent The parent menu + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the MergeFile tag */ @@ -1658,9 +1665,9 @@ efreet_menu_handle_merge_file(Efreet_Menu_Internal *parent, Efreet_Xml *xml) /** * @internal - * @param parent: The parent menu to merge into - * @param xml: The XML to be merged - * @param path: The path to the .menu file to merge + * @param parent The parent menu to merge into + * @param xml The XML to be merged + * @param path The path to the .menu file to merge */ static int efreet_menu_merge(Efreet_Menu_Internal *parent, Efreet_Xml *xml, const char *path) @@ -1711,8 +1718,8 @@ efreet_menu_merge(Efreet_Menu_Internal *parent, Efreet_Xml *xml, const char *pat /** * @internal - * @param parent: The parent menu - * @param xml: The xml tree + * @param parent The parent menu + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the MergeDir tag */ @@ -1740,9 +1747,9 @@ efreet_menu_handle_merge_dir(Efreet_Menu_Internal *parent, Efreet_Xml *xml) /** * @internal - * @param parent: the parent menu of the merge - * @param xml: The xml tree - * @param path: The path to the merge directory + * @param parent the parent menu of the merge + * @param xml The xml tree + * @param path The path to the merge directory * @return Returns 1 on success or 0 on failure * @brief Find all of the .menu files in the given directory and merge them * into the @a parent menu. @@ -1786,8 +1793,8 @@ efreet_menu_merge_dir(Efreet_Menu_Internal *parent, Efreet_Xml *xml, const char /** * @internal - * @param parent: The parent menu - * @param xml: The xml tree + * @param parent The parent menu + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the DefaultMergeDirs tag */ @@ -1848,8 +1855,8 @@ efreet_menu_handle_default_merge_dirs(Efreet_Menu_Internal *parent, Efreet_Xml * /** * @internal - * @param parent: The parent menu - * @param xml: The xml tree + * @param parent The parent menu + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the LegacyDir tag */ @@ -1874,9 +1881,9 @@ efreet_menu_handle_legacy_dir(Efreet_Menu_Internal *parent, Efreet_Xml *xml) /** * @internal - * @param parent: The parent menu - * @param legacy_dir: The legacy directory path - * @param prefix: The legacy directory prefix if one set + * @param parent The parent menu + * @param legacy_dir The legacy directory path + * @param prefix The legacy directory prefix if one set * @return Returns the Efreet_Menu_Internal representing the legacy hierarchy * @brief Handles the process of merging @a legacy_dir into @a parent menu */ @@ -2036,8 +2043,8 @@ efreet_menu_handle_legacy_dir_helper(Efreet_Menu_Internal *root, /** * @internal - * @param parent: The parent menu - * @param xml: UNUSED + * @param parent The parent menu + * @param xml UNUSED * @return Returns 1 on success or 0 on failure * @brief Handles the KDELegacyDirs tag */ @@ -2071,8 +2078,8 @@ efreet_menu_handle_kde_legacy_dirs(Efreet_Menu_Internal *parent, Efreet_Xml *xml /** * @internal - * @param parent: The parent menu - * @param xml: The xml tree + * @param parent The parent menu + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the Move tag and all subtags */ @@ -2111,8 +2118,8 @@ efreet_menu_handle_move(Efreet_Menu_Internal *parent, Efreet_Xml *xml) /** * @internal - * @param parent: The parent menu - * @param xml: The xml tree + * @param parent The parent menu + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the Old tag */ @@ -2154,8 +2161,8 @@ efreet_menu_handle_old(Efreet_Menu_Internal *parent, Efreet_Xml *xml) /** * @internal - * @param parent: The parent menu - * @param xml: The xml tree + * @param parent The parent menu + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the New tag */ @@ -2178,8 +2185,8 @@ efreet_menu_handle_new(Efreet_Menu_Internal *parent, Efreet_Xml *xml) /** * @internal - * @param parent: The parent menu - * @param xml: The xml tree + * @param parent The parent menu + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the Layout tag and all subtags */ @@ -2219,8 +2226,8 @@ efreet_menu_handle_layout(Efreet_Menu_Internal *parent, Efreet_Xml *xml) /** * @internal - * @param parent: The parent menu - * @param xml: The xml tree + * @param parent The parent menu + * @param xml The xml tree * @return Returns 1 on success or 0 on failure * @brief Handles the DefaultLayout tag */ @@ -2389,9 +2396,9 @@ efreet_menu_handle_layout_merge(Efreet_Menu_Internal *parent, Efreet_Xml *xml, i /** * @internal - * @param parent: The parent menu - * @param xml: The XML tree to parse - * @param type: The type of filter + * @param parent The parent menu + * @param xml The XML tree to parse + * @param type The type of filter * @return Returns 1 on success or 0 on failure * @brief Parses the given XML tree and adds the filter to the parent menu */ @@ -2422,8 +2429,8 @@ efreet_menu_handle_filter(Efreet_Menu_Internal *parent, Efreet_Xml *xml, /** * @internal - * @param op: The operation to work with - * @param xml: The XML tree representing this operation + * @param op The operation to work with + * @param xml The XML tree representing this operation * @return Returns 1 on success or 0 on failure * @brief Parses the given XML tree and populates the operation */ @@ -2476,7 +2483,7 @@ efreet_menu_filter_new(void) /** * @internal - * @param filter: The filter to work with + * @param filter The filter to work with * @return Returns no data * @brief Frees the given filter and all data */ @@ -2513,7 +2520,7 @@ efreet_menu_layout_new(void) /** * @internal - * @param filter: The filter to work with + * @param filter The filter to work with * @return Returns no data * @brief Frees the given filter and all data */ @@ -2543,7 +2550,7 @@ efreet_menu_filter_op_new(void) /** * @internal - * @param op: The operation to work with + * @param op The operation to work with * @return Returns no value. * @brief Frees the given operation and all sub data */ @@ -2576,7 +2583,7 @@ efreet_menu_desktop_new(void) /** * @internal - * @param md: The Efreet_Menu_Desktop to free + * @param md The Efreet_Menu_Desktop to free * @return Returns no value * @brief Frees the given structure */ @@ -2604,8 +2611,7 @@ efreet_menu_entry_new(void) } /** - * @internal - * @param entry: The Efreet_Menu to free + * @param entry The Efreet_Menu to free * @return Returns no value * @brief Frees the given structure */ @@ -2625,9 +2631,9 @@ efreet_menu_free(Efreet_Menu *entry) /** * @internal - * @param op: The op to add a child too - * @param xml: The XML tree of the child - * @param type: The type of child to add + * @param op The op to add a child too + * @param xml The XML tree of the child + * @param type The type of child to add * @return Returns 1 on success or 0 on failure * @brief Parses the given XML tree and populates a new child operation. */ @@ -2653,8 +2659,8 @@ efreet_menu_handle_filter_child_op(Efreet_Menu_Filter_Op *op, Efreet_Xml *xml, /** * @internal - * @param menu: The menu to work with - * @param only_unallocated: Do we only look for unallocated items? + * @param menu The menu to work with + * @param only_unallocated Do we only look for unallocated items? * @return Returns 1 if we've successfully processed the menu, 0 otherwise * @brief Handles the processing of the menu data to retrieve the .desktop * files for the menu @@ -2718,8 +2724,8 @@ efreet_menu_process_dirs(Efreet_Menu_Internal *internal) /** * @internal - * @param menu: the menu to process - * @param only_unallocated: Only handle menus that deal with unallocated items + * @param menu the menu to process + * @param only_unallocated Only handle menus that deal with unallocated items * @return Returns no value * @brief Handles the processing of the filters attached to the given menu. * @@ -2802,11 +2808,11 @@ efreet_menu_process_filters(Efreet_Menu_Internal *internal, unsigned int only_un /** * @internal - * @param pool: The app pool to iterate - * @param applications: The list of applications to append too - * @param matches: The hash of previously matched ids - * @param filter: The menu filter to run on the pool items - * @param only_unallocated: Do we check only unallocated pool items? + * @param pool The app pool to iterate + * @param applications The list of applications to append too + * @param matches The hash of previously matched ids + * @param filter The menu filter to run on the pool items + * @param only_unallocated Do we check only unallocated pool items? * @return Returns no value. * @brief This will iterate the items in @a pool and append them to @a * applications if they match the @a filter given and aren't previoulsy entered @@ -2837,8 +2843,8 @@ efreet_menu_process_app_pool(Eina_List *pool, Eina_List *applications, /** * @internal - * @param op: The filter operation to execute - * @param md: The desktop to run the filter on + * @param op The filter operation to execute + * @param md The desktop to run the filter on * @return Returns 1 if this desktop matches the given filter, 0 otherwise * @brief This will execute the given @a filter on the given desktop */ @@ -2859,8 +2865,8 @@ efreet_menu_filter_matches(Efreet_Menu_Filter_Op *op, Efreet_Menu_Desktop *md) /** * @internal - * @param op: The filter operation to execute - * @param md: The desktop to execute on + * @param op The filter operation to execute + * @param md The desktop to execute on * @return Returns 1 if the desktop matches, 0 otherwise * @brief Executes the OR operation, @a op, on the desktop, @a md. */ @@ -2903,8 +2909,8 @@ efreet_menu_filter_or_matches(Efreet_Menu_Filter_Op *op, Efreet_Menu_Desktop *md /** * @internal - * @param op: The filter operation to execute - * @param md: The desktop to execute on + * @param op The filter operation to execute + * @param md The desktop to execute on * @return Returns 1 if the desktop matches, 0 otherwise * @brief Executes the AND operation, @a op, on the desktop, @a md. */ @@ -2950,8 +2956,8 @@ efreet_menu_filter_and_matches(Efreet_Menu_Filter_Op *op, Efreet_Menu_Desktop *m /** * @internal - * @param op: The filter operation to execute - * @param md: The desktop to execute on + * @param op The filter operation to execute + * @param md The desktop to execute on * @return Returns 1 if the desktop matches, 0 otherwise * @brief Executes the NOT operation, @a op, on the desktop, @a md. */ @@ -3000,8 +3006,8 @@ efreet_menu_filter_not_matches(Efreet_Menu_Filter_Op *op, Efreet_Menu_Desktop *m /** * @internal - * @param dest: The destination menu - * @param src: The source menu + * @param dest The destination menu + * @param src The source menu * @return Returns no value * @brief Takes the child elements of the menu @a src and puts then on the * _start_ of the menu @a dest. @@ -3091,7 +3097,7 @@ efreet_menu_concatenate(Efreet_Menu_Internal *dest, Efreet_Menu_Internal *src) /** * @internal - * @param menu: The menu to work with + * @param menu The menu to work with * @return Returns no value * @brief Handles any \ commands in the menus */ @@ -3174,9 +3180,9 @@ error: /** * @internal - * @param menu: The menu to start searching from - * @param name: The menu name to find - * @param parent: The parent of the found menu + * @param menu The menu to start searching from + * @param name The menu name to find + * @param parent The parent of the found menu * @return Returns the menu with the given @a name or NULL if none found * @brief Searches the menu tree starting at @a menu looking for a menu with * @a name. @@ -3260,7 +3266,7 @@ efreet_menu_move_new(void) /** * @internal - * @param move: The Efreet_Menu_Move to free + * @param move The Efreet_Menu_Move to free * @return Returns no value. * @brief Frees the given move structure */ @@ -3292,7 +3298,7 @@ efreet_menu_app_dir_new(void) /** * @internal - * @param dir: The Efreet_Menu_App_Dir to free + * @param dir The Efreet_Menu_App_Dir to free * @return Returns no value. * @brief Frees the given dir structure */ @@ -3308,8 +3314,8 @@ efreet_menu_app_dir_free(Efreet_Menu_App_Dir *dir) /** * @internal - * @param a: The app dir to compare too - * @param b: The path to compare too + * @param a The app dir to compare too + * @param b The path to compare too * @return Returns 0 if the strings are equals, != 0 otherwise * @brief Compares the too strings */ @@ -3494,7 +3500,7 @@ efreet_menu_app_dir_scan(Efreet_Menu_Internal *internal, const char *path, const /** * @internal - * @param menu: The menu to work with + * @param menu The menu to work with * @return Returns 1 on success or 0 on failure * @brief Process the directory dirs in @a menu */ @@ -3531,9 +3537,9 @@ efreet_menu_directory_dirs_process(Efreet_Menu_Internal *internal) /** * @internal - * @param path: The path to scan - * @param relative_path: The relative portion of the path - * @param cache: The cache to populate + * @param path The path to scan + * @param relative_path The relative portion of the path + * @param cache The cache to populate * @return Returns 1 on success or 0 on failure * @brief Scans the given directory dir for .directory files and adds the * applications to the cache @@ -3586,8 +3592,8 @@ efreet_menu_directory_dir_scan(const char *path, const char *relative_path, /** * @internal - * @param menu: The menu to work with - * @param path: The path to work with + * @param menu The menu to work with + * @param path The path to work with * @return Returns the desktop file for this path or NULL if none exists * @brief Finds the desktop file for the given path. */ @@ -3610,8 +3616,8 @@ efreet_menu_directory_get(Efreet_Menu_Internal *internal, const char *path) /** * @internal - * @param a: The first desktop - * @param b: The second desktop + * @param a The first desktop + * @param b The second desktop * @return Returns the comparison of the desktop files * @brief Compares the desktop files. */ diff --git a/legacy/efreet/src/lib/efreet_mime.c b/legacy/efreet/src/lib/efreet_mime.c index 795301fb4d..8b79d9e558 100644 --- a/legacy/efreet/src/lib/efreet_mime.c +++ b/legacy/efreet/src/lib/efreet_mime.c @@ -293,7 +293,7 @@ efreet_mime_shutdown(void) } /** - * @param file: The file to find the mime type + * @param file The file to find the mime type * @return Returns mime type as a string * @brief Retreive the mime type of a file */ @@ -324,9 +324,9 @@ efreet_mime_type_get(const char *file) } /** - * @param mime: The name of the mime type - * @param theme: The name of the theme to search icons in - * @param size: The wanted size of the icon + * @param mime The name of the mime type + * @param theme The name of the theme to search icons in + * @param size The wanted size of the icon * @return Returns mime type icon path as a string * @brief Retreive the mime type icon for a file */ @@ -428,7 +428,7 @@ efreet_mime_type_cache_flush(void) /** - * @param file: The file to check the mime type + * @param file The file to check the mime type * @return Returns mime type as a string * @brief Retreive the mime type of a file using magic */ @@ -439,7 +439,7 @@ efreet_mime_magic_type_get(const char *file) } /** - * @param file: The file to check the mime type + * @param file The file to check the mime type * @return Returns mime type as a string * @brief Retreive the mime type of a file using globs */ @@ -489,7 +489,7 @@ efreet_mime_globs_type_get(const char *file) } /** - * @param file: The file to check the mime type + * @param file The file to check the mime type * @return Returns mime type as a string * @brief Retreive the special mime type of a file */ @@ -500,7 +500,7 @@ efreet_mime_special_type_get(const char *file) } /** - * @param file: The file to check the mime type + * @param file The file to check the mime type * @return Returns mime type as a string * @brief Retreive the fallback mime type of a file */ @@ -524,7 +524,7 @@ efreet_mime_endian_check(void) /** * @internal - * @param file: File to monitor + * @param file File to monitor * @return Returns no value. * @brief Creates a new file monitor if we aren't already monitoring the * given file @@ -548,8 +548,8 @@ efreet_mime_monitor_add(const char *file) /** * @internal - * @param datadirs: List of XDG data dirs - * @param datahome: Path to XDG data home directory + * @param datadirs List of XDG data dirs + * @param datahome Path to XDG data home directory * @return Returns no value * @brief Read all glob files in XDG data/home dirs. * Also reads the /etc/mime.types file. @@ -590,8 +590,8 @@ efreet_mime_load_globs(Eina_List *datadirs, const char *datahome) /** * @internal - * @param datadirs: List of XDG data dirs - * @param datahome: Path to XDG data home directory + * @param datadirs List of XDG data dirs + * @param datahome Path to XDG data home directory * @return Returns no value * @brief Read all magic files in XDG data/home dirs. */ @@ -621,10 +621,10 @@ efreet_mime_load_magics(Eina_List *datadirs, const char *datahome) /** * @internal - * @param data: Data pointer passed to monitor_add - * @param monitor: Ecore_File_Monitor associated with this event - * @param event: The type of event - * @param path: Path to the file that was updated + * @param data Data pointer passed to monitor_add + * @param monitor Ecore_File_Monitor associated with this event + * @param event The type of event + * @param path Path to the file that was updated * @return Returns no value * @brief Callback for all file monitors. Just reloads the appropriate * list depending on which file changed. If it was a magic file @@ -654,8 +654,8 @@ efreet_mime_cb_update_file(void *data __UNUSED__, /** * @internal - * @param datadirs: List of XDG data dirs - * @param datahome: Path to XDG data home directory + * @param datadirs List of XDG data dirs + * @param datahome Path to XDG data home directory * @return Returns 1 on success, 0 on failure * @brief Initializes globs, magics, and monitors lists. */ @@ -708,7 +708,7 @@ efreet_mime_init_files(void) /** * @internal - * @param file: File to examine + * @param file File to examine * @return Returns mime type if special file, else NULL * @brief Returns a mime type based on the stat of a file. * This is used first to catch directories and other special @@ -802,7 +802,7 @@ efreet_mime_special_check(const char *file) /** * @internal - * @param file: File to examine + * @param file File to examine * @return Returns mime type or NULL if the file doesn't exist * @brief Returns text/plain if the file appears to contain text and * returns application/octet-stream if it appears to be binary. @@ -843,7 +843,7 @@ efreet_mime_fallback_check(const char *file) /** * @internal - * @param glob: Glob to search for + * @param glob Glob to search for * @return Returns 1 on success, 0 on failure * @brief Removes a glob from the list */ @@ -866,7 +866,7 @@ efreet_mime_glob_remove(const char *glob) /** * @internal - * @param file: mime.types file to load + * @param file mime.types file to load * @return Returns no value * @brief Loads values from a mime.types style file * into the globs list. @@ -920,7 +920,7 @@ efreet_mime_mime_types_load(const char *file) /** * @internal - * @param file: globs file to load + * @param file globs file to load * @return Returns no value * @brief Loads values from a mime.types style file * into the globs list. @@ -999,7 +999,7 @@ efreet_mime_shared_mimeinfo_globs_load(const char *file) /** * @internal - * @param in: Number to count the digits + * @param in Number to count the digits * @return Returns number of digits * @brief Calculates and returns the number of digits * in a number. @@ -1017,7 +1017,7 @@ efreet_mime_count_digits(int in) /** * @internal - * @param file: File to parse + * @param file File to parse * @return Returns no value * @brief Loads a magic file and adds information to magics list */ @@ -1049,7 +1049,7 @@ efreet_mime_shared_mimeinfo_magic_load(const char *file) } /** - * @param data: The data from the file + * @param data The data from the file * @return Returns no value * @brief Parses a magic file * @note Format: @@ -1259,9 +1259,9 @@ efreet_mime_shared_mimeinfo_magic_parse(char *data, int size) /** * @internal - * @param file: File to check - * @param start: Start priority, if 0 start at beginning - * @param end: End priority, should be less then start + * @param file File to check + * @param start Start priority, if 0 start at beginning + * @param end End priority, should be less then start * unless start * @return Returns mime type for file if found, NULL if not * @brief Applies magic rules to a file given a start and end priority @@ -1362,7 +1362,7 @@ efreet_mime_magic_check_priority(const char *file, /** * @internal - * @param data: Data pointer that is being destroyed + * @param data Data pointer that is being destroyed * @return Returns no value * @brief Callback for globs destroy */ @@ -1378,7 +1378,7 @@ efreet_mime_glob_free(void *data) /** * @internal - * @param data: Data pointer that is being destroyed + * @param data Data pointer that is being destroyed * @return Returns no value * @brief Callback for magics destroy */ @@ -1394,7 +1394,7 @@ efreet_mime_magic_free(void *data) /** * @internal - * @param data: Data pointer that is being destroyed + * @param data Data pointer that is being destroyed * @return Returns no value * @brief Callback for magic entry destroy */ @@ -1411,8 +1411,8 @@ efreet_mime_magic_entry_free(void *data) /** * @internal - * @param str: String (filename) to match - * @param glob: Glob to match str to + * @param str String (filename) to match + * @param glob Glob to match str to * @return Returns 1 on success, 0 on failure * @brief Compares str to glob, case sensitive */ @@ -1431,8 +1431,8 @@ efreet_mime_glob_match(const char *str, const char *glob) /** * @internal - * @param str: String (filename) to match - * @param glob: Glob to match str to + * @param str String (filename) to match + * @param glob Glob to match str to * @return Returns 1 on success, 0 on failure * @brief Compares str to glob, case insensitive (expects str already in lower case) */ diff --git a/legacy/efreet/src/lib/efreet_trash.c b/legacy/efreet/src/lib/efreet_trash.c index a0613833a4..2efe153033 100644 --- a/legacy/efreet/src/lib/efreet_trash.c +++ b/legacy/efreet/src/lib/efreet_trash.c @@ -172,8 +172,8 @@ efreet_trash_dir_get(const char *file) } /** - * @param uri: The local uri to move in the trash - * @param force_delete: If you set this to 1 than files on different filesystems + * @param uri The local uri to move in the trash + * @param force_delete If you set this to 1 than files on different filesystems * will be deleted permanently * @return Return 1 on success, 0 on failure or -1 in case the uri is not on the * same filesystem and force_delete is not set. diff --git a/legacy/efreet/src/lib/efreet_uri.c b/legacy/efreet/src/lib/efreet_uri.c index 39e657c6e4..fe041bca34 100644 --- a/legacy/efreet/src/lib/efreet_uri.c +++ b/legacy/efreet/src/lib/efreet_uri.c @@ -20,7 +20,7 @@ /** - * @param full_uri: a valid uri string to parse + * @param full_uri a valid uri string to parse * @return Return The corresponding Efreet_Uri structure. Or NULL on errors. * @brief Read a single uri and return an Efreet_Uri struct. If there's no * hostname in the uri then the hostname parameter will be NULL. All the uri @@ -84,7 +84,7 @@ efreet_uri_decode(const char *full_uri) } /** - * @param uri: Create an URI string from an Efreet_Uri struct + * @param uri Create an URI string from an Efreet_Uri struct * @return The string rapresentation of uri (ex: 'file:///home/my%20name') * @brief Get the string rapresentation of the given uri struct escaping * illegal caracters. Remember to free the string with eina_stringshare_del() @@ -119,7 +119,7 @@ efreet_uri_encode(Efreet_Uri *uri) } /** - * @param uri: The uri to free + * @param uri The uri to free * @brief Free the given uri structure. */ EAPI void diff --git a/legacy/efreet/src/lib/efreet_xml.c b/legacy/efreet/src/lib/efreet_xml.c index 6ea427c6de..d47ed7911e 100644 --- a/legacy/efreet/src/lib/efreet_xml.c +++ b/legacy/efreet/src/lib/efreet_xml.c @@ -81,7 +81,7 @@ efreet_xml_shutdown(void) /** * @internal - * @param file: The file to parse + * @param file The file to parse * @return Returns an Efreet_Xml structure for the given file @a file or * NULL on failure * @brief Parses the given file into an Efreet_Xml structure. @@ -123,7 +123,7 @@ efreet_error: /** * @internal - * @param xml: The Efree_Xml to free + * @param xml The Efree_Xml to free * @return Returns no value * @brief Frees up the given Efreet_Xml structure */ @@ -153,8 +153,8 @@ efreet_xml_del(Efreet_Xml *xml) } /** - * @param xml: The xml struct to work with - * @param key: The attribute key to look for + * @param xml The xml struct to work with + * @param key The attribute key to look for * @return Returns the value for the given key, or NULL if none found * @brief Retrieves the value for the given attribute key */