/**
* @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
/**
* @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.
/**
* @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.
/**
* @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
}
/**
- * @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
}
/**
- * @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
*/
}
/**
- * @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
*/
}
/**
- * @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
}
/**
- * @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
}
/**
- * @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
}
/**
- * @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
*/
}
/**
- * @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
*/
}
/**
- * @param environment: the environment name
+ * @param environment the environment name
* @brief sets the global desktop environment name
*/
EAPI void
}
/**
- * @return environment: the environment name
+ * @return environment the environment name
* @brief sets the global desktop environment name
*/
EAPI const char *
}
/**
- * @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
}
/**
- * @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
}
/**
- * @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
*/
}
/**
- * @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
*/
}
/**
- * @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
*/
}
/**
- * @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
*/
/**
* @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.
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
/**
- * @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.
*/
}
/**
- * @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.
*/
}
/**
- * @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
*
}
/**
- * @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.
* 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 *
}
/**
- * @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)
/**
* @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
*/
/**
* @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 *
}
/**
- * @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)
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)
{
}
/**
- * @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
*/
}
/**
- * @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
/**
* @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.
*/
#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.
#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.
}
/**
- * @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
}
/**
- * @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.
#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
/**
* @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
/**
* @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
/**
* @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
/**
* @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.
/**
* @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
/**
* @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
/**
* @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
*/
/**
* @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
*/
/**
* @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.
/**
* @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
}
/**
- * @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.
*/
/**
* @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
*/
/**
* @internal
- * @param theme: The theme to free
+ * @param theme The theme to free
* @return Returns no value
* @brief Frees up the @a theme structure.
*/
/**
* @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.
/**
* @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.
/**
* @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
/**
* @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
/**
* @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
*/
/**
* @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
/**
* @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
*/
};
/**
- * 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
}
/**
- * @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
}
/**
- * @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.
*/
}
/**
- * @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.
*/
}
/**
- * @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
*/
}
/**
- * @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
*/
}
/**
- * @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.
}
/**
- * @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
*/
}
/**
- * @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.
}
/**
- * @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
*/
}
/**
- * @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.
}
/**
- * @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
*/
}
/**
- * @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
*/
}
/**
- * @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
*/
}
/**
- * @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
}
/**
- * @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
*/
}
/**
- * @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
*/
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)
{
}
/**
- * @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
}
/**
- * @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
*/
}
/**
- * @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.
}
/**
- * @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.
}
/**
- * @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
*/
}
/**
- * @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.
}
/**
- * @param menu: The menu to free
+ * @param menu The menu to free
* @return Returns no value
* @brief Frees up the given menu structure
*/
/**
* @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
*
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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.
*/
/**
* @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
*
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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)
/**
* @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
*/
/**
* @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.
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
}
/**
- * @internal
- * @param entry: The Efreet_Menu to free
+ * @param entry The Efreet_Menu to free
* @return Returns no value
* @brief Frees the given structure
*/
/**
* @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.
*/
/**
* @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
/**
* @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.
*
/**
* @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
/**
* @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
*/
/**
* @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.
*/
/**
* @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.
*/
/**
* @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.
*/
/**
* @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.
/**
* @internal
- * @param menu: The menu to work with
+ * @param menu The menu to work with
* @return Returns no value
* @brief Handles any \<Move\> commands in the menus
*/
/**
* @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.
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
/**
* @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.
*/
/**
* @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.
*/
}
/**
- * @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
*/
}
/**
- * @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
*/
/**
- * @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
*/
}
/**
- * @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
*/
}
/**
- * @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
*/
}
/**
- * @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
*/
/**
* @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
/**
* @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.
/**
* @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.
*/
/**
* @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
/**
* @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.
*/
/**
* @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
/**
* @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.
/**
* @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
*/
/**
* @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.
/**
* @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.
/**
* @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.
/**
* @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
*/
}
/**
- * @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:
/**
* @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
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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
*/
/**
* @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)
*/
}
/**
- * @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.
/**
- * @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
}
/**
- * @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()
}
/**
- * @param uri: The uri to free
+ * @param uri The uri to free
* @brief Free the given uri structure.
*/
EAPI 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.
/**
* @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
*/
}
/**
- * @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
*/
projects / framework / uifw / efreet.git / commitdiff