SVN revision: 56326
devs/devilhorns/wayland_egl
Sebastian Dransfeld 12 years ago
parent 3997a22f3a
commit 978741a789
  1. 8
      legacy/efreet/src/lib/efreet.c
  2. 8
      legacy/efreet/src/lib/efreet_base.c
  3. 84
      legacy/efreet/src/lib/efreet_desktop.c
  4. 38
      legacy/efreet/src/lib/efreet_desktop_command.c
  5. 118
      legacy/efreet/src/lib/efreet_icon.c
  6. 4
      legacy/efreet/src/lib/efreet_icon.h
  7. 70
      legacy/efreet/src/lib/efreet_ini.c
  8. 272
      legacy/efreet/src/lib/efreet_menu.c
  9. 74
      legacy/efreet/src/lib/efreet_mime.c
  10. 4
      legacy/efreet/src/lib/efreet_trash.c
  11. 6
      legacy/efreet/src/lib/efreet_uri.c
  12. 8
      legacy/efreet/src/lib/efreet_xml.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.

@ -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

@ -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

@ -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 *

@ -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
*/

@ -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

@ -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
*/

@ -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