aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/efreet
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/efreet')
-rw-r--r--src/lib/efreet/Efreet.h95
-rw-r--r--src/lib/efreet/Efreet_Mime.h83
-rw-r--r--src/lib/efreet/Efreet_Trash.h67
-rw-r--r--src/lib/efreet/efreet_base.h202
-rw-r--r--src/lib/efreet/efreet_desktop.h189
-rw-r--r--src/lib/efreet/efreet_icon.h69
-rw-r--r--src/lib/efreet/efreet_ini.h125
-rw-r--r--src/lib/efreet/efreet_menu.h109
-rw-r--r--src/lib/efreet/efreet_uri.h20
-rw-r--r--src/lib/efreet/efreet_utils.h43
10 files changed, 409 insertions, 593 deletions
diff --git a/src/lib/efreet/Efreet.h b/src/lib/efreet/Efreet.h
index 419e5ff531..fdf1003e87 100644
--- a/src/lib/efreet/Efreet.h
+++ b/src/lib/efreet/Efreet.h
@@ -2,26 +2,31 @@
#define EFREET_H
/**
+ * @internal
* @file Efreet.h
+ *
* @brief The file that must be included by any project wishing to use
- * Efreet. Efreet.h provides all of the necessary headers and includes to
- * work with Efreet.
+ * Efreet. Efreet.h provides all the necessary headers and includes to
+ * work with Efreet.
*/
/**
+ * @internal
+ * @defgroup Efreet_Group Efreet
+ * @ingroup EFL_Group
+ *
* @page efreet_main Efreet
*
* @section toc Table of Contents
*
* @li @ref efreet_main_intro
- * @li @ref efreet_main_compiling
* @li @ref efreet_main_next_steps
*
* @section efreet_main_intro Introduction
*
- * Efreet is a library designed to help apps work several of the
- * Freedesktop.org standards regarding Icons, Desktop files and Menus. To
- * that end it implements the following specifications:
+ * @brief Efreet is a library designed to help applications work with several of the
+ * Freedesktop.org standards regarding Icons, Desktop files, and Menus. On the
+ * same lines it implements the following specifications:
*
* @li XDG Base Directory Specification
* @li Icon Theme Specification
@@ -31,28 +36,6 @@
* @li Shared Mime Info Specification
* @li Trash Specification
*
- * @section efreet_main_compiling How to compile
- *
- * Efreet is a library your application links to. The procedure for
- * this is very simple. You simply have to compile your application
- * with the appropriate compiler flags that the @c pkg-config script
- * outputs. Mime and Thrash are separated modules. For example, to
- * compile with mime support:
- *
- * Compiling C or C++ files into object files:
- *
- * @verbatim
- gcc -c -o main.o main.c `pkg-config --cflags efreet efreet-mime`
- @endverbatim
- *
- * Linking object files into a binary executable:
- *
- * @verbatim
- gcc -o my_application main.o `pkg-config --libs efreet efreet-mime`
- @endverbatim
- *
- * See @ref pkgconfig
- *
* @section efreet_main_next_steps Next Steps
*
* After you understood what Efreet is and installed it in your system
@@ -60,19 +43,19 @@
*
* Recommended reading:
*
- * @li @ref Efreet_Base for base directory specification (XDG variables).
+ * @li @ref Efreet_Base_Group for base directory specification (XDG variables).
* @li @ref Efreet_Desktop to access .desktop files
* @li @ref Efreet_Menu to access menus of .desktop files
- * @li @ref Efreet_Mime to identify files based on extension or header.
- * @li @ref Efreet_Trash to access file trash implementation.
+ * @li @ref Efreet_Mime_Group to identify files based on extension or header.
+ * @li @ref Efreet_Trash_Group to access file trash implementation.
* @li @ref Efreet_Ini for parsing INI-like key-value files.
* @li @ref Efreet_Uri for URI parsing and encoding.
- * @li @ref Efreet_Utils general utilities.
+ * @li @ref Efreet_Utils_Group general utilities.
*
+ * @{
*/
#include <Eina.h>
-#include <Efl_Config.h>
#ifdef EAPI
# undef EAPI
@@ -104,22 +87,19 @@
extern "C" {
#endif
-#define EFREET_VERSION_MAJOR EFL_VERSION_MAJOR
-#define EFREET_VERSION_MINOR EFL_VERSION_MINOR
- /**
- * @typedef Efreet_Version
- * Represents the current version of Efreet
- */
- typedef struct _Efreet_Version
- {
- int major; /** < major (binary or source incompatible changes) */
- int minor; /** < minor (new features, bugfixes, major improvements version) */
- int micro; /** < micro (bugfix, internal improvements, no new features version) */
- int revision; /** < git revision (0 if a proper release or the git revision number Efreet is built from) */
- } Efreet_Version;
-
- EAPI extern Efreet_Version *efreet_version;
+#define EFREET_VERSION_MAJOR 1
+#define EFREET_VERSION_MINOR 8
+typedef struct _Efreet_Version
+ {
+ int major;
+ int minor;
+ int micro;
+ int revision;
+ } Efreet_Version;
+
+EAPI extern Efreet_Version *efreet_version;
+
#include "efreet_base.h"
#include "efreet_ini.h"
#include "efreet_icon.h"
@@ -129,26 +109,31 @@ extern "C" {
#include "efreet_uri.h"
/**
- * @return Value > @c 0 if the initialization was successful, @c 0 otherwise.
- * @brief Initializes the Efreet system
+ * @brief Initializes the Efreet system.
+ *
+ * @return The value > @c 0 if the initialization is successful, otherwise @c 0
*/
EAPI int efreet_init(void);
/**
+ * @brief Shuts down Efreet if a balanced number of init/shutdown calls have been made.
+ *
* @return The number of times the init function has been called minus the
- * corresponding init call.
- * @brief Shuts down Efreet if a balanced number of init/shutdown calls have
- * been made
+ * corresponding init call
*/
EAPI int efreet_shutdown(void);
/**
- * @brief Resets language dependent variables and resets language dependent
- * caches This must be called whenever the locale is changed.
+ * @brief Resets the language dependent variables and resets the language dependent
+ * caches. This must be called whenever the locale is changed.
* @since 1.7
*/
EAPI void efreet_lang_reset(void);
+/**
+ * @}
+ */
+
#ifdef __cplusplus
}
#endif
diff --git a/src/lib/efreet/Efreet_Mime.h b/src/lib/efreet/Efreet_Mime.h
index cbde578876..23b26c3a9c 100644
--- a/src/lib/efreet/Efreet_Mime.h
+++ b/src/lib/efreet/Efreet_Mime.h
@@ -2,15 +2,20 @@
#define EFREET_MIME_H
/**
+ * @internal
* @file Efreet_Mime.h
- * @brief The file that must be included by any project wishing to use
- * @addtogroup Efreet_Mime Efreet_Mime: The XDG Shared Mime Info standard
- * Efreet Mime is a library designed to help apps work with the
+ *
+ * @brief The file that must be included by any project wishing to use Efreet_Mime.
+ *
+ * @internal
+ * @defgroup Efreet_Mime_Group Efreet_Mime: The XDG Shared Mime Info standard
+ * @ingroup Efreet_Group
+ *
+ * Efreet Mime is a library designed to help applications work with the
* Freedesktop.org Shared Mime Info standard.
- * Efreet_Mime.h provides all of the necessary headers and
+ * Efreet_Mime.h provides all the necessary headers and
* includes to work with Efreet_Mime.
*
- * @ingroup Efreet
* @{
*/
@@ -19,7 +24,7 @@
#endif
#ifdef _WIN32
-# ifdef EFL_EFREET_BUILD
+# ifdef EFL_EFREET_MIME_BUILD
# ifdef DLL_EXPORT
# define EAPI __declspec(dllexport)
# else
@@ -46,75 +51,83 @@ extern "C" {
/**
- * @return @c 1 on success or @c 0 on failure.
- * @brief Initializes the efreet mime settings
+ * @brief Initializes the efreet mime settings.
+ *
+ * @return @c 1 on success, otherwise @c 0 on failure
*/
EAPI int efreet_mime_init(void);
/**
+ * @brief Shuts down the Efreet mime settings system if a balanced number of
+ * init/shutdown calls have been made.
+ *
* @return The number of times the init function has been called minus the
- * corresponding init call.
- * @brief Shuts down Efreet mime settings system if a balanced number of
- * init/shutdown calls have been made
+ * corresponding init call
*/
EAPI int efreet_mime_shutdown(void);
/**
- * @param file The file to find the mime type
- * @return Mime type as a string.
- * @brief Retrieve the mime type of a file
+ * @brief Gets the mime type of a file.
+ *
+ * @param[in] file The file to find the mime type of
+ * @return The mime type as a string
*/
EAPI const char *efreet_mime_type_get(const char *file);
/**
- * @param file The file to check the mime type
- * @return Mime type as a string.
- * @brief Retrieve the mime type of a file using magic
+ * @brief Gets the mime type of a file using magic.
+ *
+ * @param[in] file The file to check the mime type of
+ * @return The mime type as a string
*/
EAPI const char *efreet_mime_magic_type_get(const char *file);
/**
- * @param file The file to check the mime type
- * @return Mime type as a string.
- * @brief Retrieve the mime type of a file using globs
+ * @brief Gets the mime type of a file using globs.
+ *
+ * @param[in] file The file to check the mime type of
+ * @return The mime type as a string
*/
EAPI const char *efreet_mime_globs_type_get(const char *file);
/**
- * @param file The file to check the mime type
- * @return Mime type as a string.
- * @brief Retrieve the special mime type of a file
+ * @brief Gets the special mime type of a file.
+ *
+ * @param[in] file The file to check the mime type of
+ * @return The mime type as a string
*/
EAPI const char *efreet_mime_special_type_get(const char *file);
/**
- * @param file The file to check the mime type
- * @return Mime type as a string.
- * @brief Retrieve the fallback mime type of a file.
+ * @brief Gets the fallback mime type of a file.
+ *
+ * @param[in] file The file to check the mime type of
+ * @return The mime type as a string
*/
EAPI const char *efreet_mime_fallback_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
- * @return Mime type icon path as a string.
- * @brief Retrieve the mime type icon for a file.
+ * @brief Gets the mime type icon for a file.
+ *
+ * @param[in] mime The name of the mime type
+ * @param[in] theme The name of the theme to search icons in
+ * @param[in] size The required size of the icon
+ * @return The mime type icon path as a string
*/
EAPI const char *efreet_mime_type_icon_get(const char *mime, const char *theme,
unsigned int size);
/**
- * @brief Clear mime icons mapping cache
+ * @brief Clears the mime icons mapping cache.
*/
EAPI void efreet_mime_type_cache_clear(void);
/**
- * @brief Flush mime icons mapping cache
+ * @brief Flushes the mime icons mapping cache.
*
- * Flush timeout is defined at compile time by
- * EFREET_MIME_ICONS_FLUSH_TIMEOUT
+ * @remarks Flush timeout is defined at compile time by
+ * EFREET_MIME_ICONS_FLUSH_TIMEOUT.
*/
EAPI void efreet_mime_type_cache_flush(void);
diff --git a/src/lib/efreet/Efreet_Trash.h b/src/lib/efreet/Efreet_Trash.h
index 64af9ea74c..5cda3ab368 100644
--- a/src/lib/efreet/Efreet_Trash.h
+++ b/src/lib/efreet/Efreet_Trash.h
@@ -6,7 +6,7 @@
#endif
#ifdef _WIN32
-# ifdef EFL_EFREET_BUILD
+# ifdef EFL_EFREET_TRASH_BUILD
# ifdef DLL_EXPORT
# define EAPI __declspec(dllexport)
# else
@@ -33,63 +33,76 @@ extern "C" {
/**
* @file Efreet_Trash.h
+ *
* @brief Contains the methods used to support the FDO trash specification.
- * @addtogroup Efreet_Trash Efreet_Trash: The XDG Trash Specification
- * Efreet_Trash.h provides all of the necessary headers and includes to
+ *
+ * @internal
+ * @defgroup Efreet_Trash_Group Efreet_Trash: The XDG Trash Specification
+ * @ingroup Efreet_Group
+ *
+ * Efreet_Trash.h provides all the necessary headers and includes to
* work with Efreet_Trash.
*
- * @ingroup Efreet
* @{
*/
/**
- * @return @c 1 on success or @c 0 on failure.
- * @brief Initializes the efreet trash system
+ * @brief Initializes the efreet trash system.
+ *
+ * @return @c 1 on success, otherwise @c 0 on failure
*/
EAPI int efreet_trash_init(void);
/**
- * @return No value.
- * @brief Cleans up the efreet trash system
+ * @brief Cleans up the efreet trash system.
+ *
+ * @return No value
*/
EAPI int efreet_trash_shutdown(void);
/**
- * @return The XDG Trash local directory or @c NULL on errors.
- * Return value must be freed with eina_stringshare_del.
- * @brief Retrieves the XDG Trash local directory
+ * @brief Gets the XDG Trash local directory.
+ *
+ * @remarks The return value must be freed using eina_stringshare_del.
+ *
+ * @return The XDG Trash local directory, otherwise @c NULL on errors
*/
EAPI const char *efreet_trash_dir_get(const char *for_file);
/**
- * @param uri The local uri to move in the trash
- * @param force_delete If you set this to @c 1 than files on different filesystems
- * will be deleted permanently
- * @return @c 1 on success, @c 0 on failure or @c -1 in case the uri is not on
- * the same filesystem and force_delete is not set.
- * @brief This function try to move the given uri to the trash. Files on
- * different filesystem can't be moved to trash. If force_delete
- * is @c 0 than non-local files will be ignored and @c -1 is returned, if you set
- * force_delete to @c 1 non-local files will be deleted without asking.
+ * @brief Tries to move the given URI to the trash.
+ *
+ * @remarks Files on a different filesystem can't be moved to trash. If force_delete
+ * is @c 0 then non-local files are ignored and @c -1 is returned, if you set
+ * @a force_delete to @c 1 non-local files are deleted without asking.
+ *
+ * @param[in] uri The local URI to move to the trash
+ * @param[in] force_delete If @c 1 then files on a different filesystem are deleted permanently
+ *
+ * @return @c 1 on success, otherwise @c 0 on failure or @c -1 if the uri is not on
+ * the same filesystem and force_delete is not set
*/
EAPI int efreet_trash_delete_uri(Efreet_Uri *uri, int force_delete);
/**
- * @return A list of strings with filename (remember to free the list
- * when you don't need anymore).
- * @brief List all the files and directory currently inside the trash.
+ * @brief Lists all the files and directories currently inside the trash.
+ *
+ * @return A list of strings with a filename (remember to free the list
+ * when you don't need it anymore)
*/
EAPI Eina_List *efreet_trash_ls(void);
/**
- * @return @c 1 if the trash is empty or @c 0 if some file are in.
- * @brief Check if the trash is currently empty
+ * @brief Checks whether the trash is currently empty.
+ *
+ * @return @c 1 if the trash is empty, otherwise @c 0 if some files are present in it
*/
EAPI int efreet_trash_is_empty(void);
/**
- * @return @c 1 on success or @c 0 on failure.
- * @brief Delete all the files inside the trash.
+ * @brief Deletes all the files inside the trash.
+ *
+ * @return @c 1 on success, otherwise @c 0 on failure
*/
EAPI int efreet_trash_empty_trash(void);
diff --git a/src/lib/efreet/efreet_base.h b/src/lib/efreet/efreet_base.h
index ca011d95a3..46351bc57c 100644
--- a/src/lib/efreet/efreet_base.h
+++ b/src/lib/efreet/efreet_base.h
@@ -4,12 +4,11 @@
* @file efreet_base.h
* @brief Contains the methods used to support the FDO base directory
* specification.
- * @addtogroup Efreet_Base Efreet_Base: The XDG Base Directory Specification
- * functions
- * @ingroup Efreet
*
- * @see http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
- * @see http://0pointer.de/blog/projects/tmp.html
+ * @internal
+ * @defgroup Efreet_Base_Group Efreet_Base: The XDG Base Directory Specification
+ * functions
+ * @ingroup Efreet_Group
*
* @{
*/
@@ -18,9 +17,6 @@
/**
* @return Returns the XDG Data Home directory
* @brief Retrieves the XDG Data Home directory
- *
- * This is where user-specific data files should be written
- * ($XDG_DATA_HOME or $HOME/.local/share).
*/
EAPI const char *efreet_data_home_get(void);
@@ -28,9 +24,6 @@ EAPI const char *efreet_data_home_get(void);
* @return Returns the Eina_List of preference ordered extra data directories
* @brief Returns the Eina_List of preference ordered extra data directories
*
- * Ordered base directories relative to which data files should be
- * searched ($XDG_DATA_DIRS or /usr/local/share/:/usr/share/)
- *
* @note The returned list is static inside Efreet. If you add/remove from the
* list then the next call to efreet_data_dirs_get() will return your
* modified values. DO NOT free this list.
@@ -41,151 +34,21 @@ EAPI Eina_List *efreet_data_dirs_get(void);
/**
* @return Returns the XDG Config Home directory
* @brief Retrieves the XDG Config Home directory
- *
- * This is where user-specific configuration files should be
- * written ($XDG_CONFIG_HOME or $HOME/.config).
*/
EAPI const char *efreet_config_home_get(void);
/**
* @return Returns the XDG Desktop directory
* @brief Retrieves the XDG Desktop directory
- *
- * This is where user-specific desktop files should be located. It's
- * localized (translated) to current user locale
- * (~/.config/user-dirs.locale and ~/.config/user-dirs.dirs).
- *
* @since 1.3
*/
EAPI const char *efreet_desktop_dir_get(void);
/**
- * @return Returns the XDG Download directory
- * @brief Retrieves the XDG Download directory
- *
- * This is where user-specific download files should be located. It's
- * localized (translated) to current user locale
- * (~/.config/user-dirs.locale and ~/.config/user-dirs.dirs).
- *
- * It's meant for large download or in-progress downloads, it's
- * private for the user but may be shared among different
- * machines. It's not automatically cleaned up.
- *
- * @see efreet_cache_home_get()
- * @see efreet_runtime_dir_get()
- * @see http://0pointer.de/blog/projects/tmp.html
- *
- * @since 1.8
- */
-EAPI const char *efreet_download_dir_get(void);
-
-/**
- * @return Returns the XDG Templates directory
- * @brief Retrieves the XDG Templates directory
- *
- * This is where user-specific template files should be located. It's
- * localized (translated) to current user locale
- * (~/.config/user-dirs.locale and ~/.config/user-dirs.dirs).
- *
- * @see efreet_documents_dir_get()
- * @see efreet_music_dir_get()
- * @see efreet_pictures_dir_get()
- * @see efreet_videos_dir_get()
- *
- * @since 1.8
- */
-EAPI const char *efreet_templates_dir_get(void);
-
-/**
- * @return Returns the XDG Public Share directory
- * @brief Retrieves the XDG Public Share directory
- *
- * This is where user-specific public shareable files should be
- * located. It's localized (translated) to current user locale
- * (~/.config/user-dirs.locale and ~/.config/user-dirs.dirs).
- *
- * Usually local file servers should look here (Apache, Samba, FTP).
- *
- * @since 1.8
- */
-EAPI const char *efreet_public_share_dir_get(void);
-
-/**
- * @return Returns the XDG Documents directory
- * @brief Retrieves the XDG Documents directory
- *
- * This is where user-specific documents files should be located. It's
- * localized (translated) to current user locale
- * (~/.config/user-dirs.locale and ~/.config/user-dirs.dirs).
- *
- * @see efreet_templates_dir_get()
- * @see efreet_music_dir_get()
- * @see efreet_pictures_dir_get()
- * @see efreet_videos_dir_get()
- *
- * @since 1.8
- */
-EAPI const char *efreet_documents_dir_get(void);
-
-/**
- * @return Returns the XDG Music directory
- * @brief Retrieves the XDG Music directory
- *
- * This is where user-specific music files should be located. It's
- * localized (translated) to current user locale
- * (~/.config/user-dirs.locale and ~/.config/user-dirs.dirs).
- *
- * @see efreet_templates_dir_get()
- * @see efreet_download_dir_get()
- * @see efreet_pictures_dir_get()
- * @see efreet_videos_dir_get()
- *
- * @since 1.8
- */
-EAPI const char *efreet_music_dir_get(void);
-
-/**
- * @return Returns the XDG Pictures directory
- * @brief Retrieves the XDG Pictures directory
- *
- * This is where user-specific pictures files should be located. It's
- * localized (translated) to current user locale
- * (~/.config/user-dirs.locale and ~/.config/user-dirs.dirs).
- *
- * @see efreet_templates_dir_get()
- * @see efreet_documents_dir_get()
- * @see efreet_music_dir_get()
- * @see efreet_videos_dir_get()
- *
- * @since 1.8
- */
-EAPI const char *efreet_pictures_dir_get(void);
-
-/**
- * @return Returns the XDG Videos directory
- * @brief Retrieves the XDG Videos directory
- *
- * This is where user-specific video files should be located. It's
- * localized (translated) to current user locale
- * (~/.config/user-dirs.locale and ~/.config/user-dirs.dirs).
- *
- * @see efreet_templates_dir_get()
- * @see efreet_documents_dir_get()
- * @see efreet_music_dir_get()
- * @see efreet_pictures_dir_get()
- *
- * @since 1.8
- */
-EAPI const char *efreet_videos_dir_get(void);
-
-/**
* @return Returns the Eina_List of preference ordered extra config directories
* @brief Returns the Eina_List of preference ordered extra config
* directories
*
- * Ordered base directories relative to which configuration files
- * should be searched ($XDG_CONFIG_DIRS or /etc/xdg)
- *
* @note The returned list is static inside Efreet. If you add/remove from the
* list then the next call to efreet_config_dirs_get() will return your
* modified values. DO NOT free this list.
@@ -196,65 +59,10 @@ EAPI Eina_List *efreet_config_dirs_get(void);
/**
* @return Returns the XDG Cache Home directory
* @brief Retrieves the XDG Cache Home directory
- *
- * This is the base directory relative to which user specific
- * non-essential data files should be stored ($XDG_CACHE_HOME or
- * $HOME/.cache).
- *
- * @see efreet_runtime_dir_get()
- * @see efreet_download_dir_get()
- * @see efreet_config_home_get()
*/
EAPI const char *efreet_cache_home_get(void);
/**
- * @return Returns the XDG User Runtime directory.
- * @brief Retrieves the XDG User Runtime directory.
- *
- * This is the base directory relative to which user-specific
- * non-essential runtime files and other file objects (such as
- * sockets, named pipes, ...) should be stored. The directory @b must
- * be owned by the user, and he @b must be the only one having read
- * and write access to it. Its Unix access mode @b must be 0700.
- *
- * The lifetime of this directory @b must be bound to the user being
- * logged in. It @b must be created when the user first logs in and if
- * the user fully logs out the directory @b must be removed. If the
- * user logs in more than once he should get pointed to the same
- * directory, and it is mandatory that the directory continues to
- * exist from his first login to his last logout on the system, and
- * not removed in between. Files in the directory @b must not survive
- * reboot or a full logout/login cycle.
- *
- * The directory @b must be on a local file system and not shared with
- * any other system. The directory @b must by fully-featured by the
- * standards of the operating system. More specifically, on Unix-like
- * operating systems AF_UNIX sockets, symbolic links, hard links,
- * proper permissions, file locking, sparse files, memory mapping,
- * file change notifications, a reliable hard link count must be
- * supported, and no restrictions on the file name character set
- * should be imposed. Files in this directory @b may be subjected to
- * periodic clean-up. To ensure that your files are not removed, they
- * should have their access time timestamp modified at least once
- * every 6 hours of monotonic time or the 'sticky' bit should be set
- * on the file.
- *
- * If @c NULL applications should fall back to a replacement directory
- * with similar capabilities and print a warning message. Applications
- * should use this directory for communication and synchronization
- * purposes and should not place larger files in it, since it might
- * reside in runtime memory and cannot necessarily be swapped out to
- * disk.
- *
- * @note this directory is similar to @c /run and is often created in
- * tmpfs (memory-only/RAM filesystem). It is created, managed and
- * cleaned automatically by systemd.
- *
- * @since 1.8
- */
-EAPI const char *efreet_runtime_dir_get(void);
-
-/**
* @return Returns the current hostname
* @brief Returns the current hostname or empty string if not found
*/
@@ -271,7 +79,7 @@ typedef struct _Efreet_Event_Cache_Update Efreet_Event_Cache_Update;
*/
struct _Efreet_Event_Cache_Update
{
- int error;
+ int dummy;
};
/**
diff --git a/src/lib/efreet/efreet_desktop.h b/src/lib/efreet/efreet_desktop.h
index 8f2c30a4e6..fe95124654 100644
--- a/src/lib/efreet/efreet_desktop.h
+++ b/src/lib/efreet/efreet_desktop.h
@@ -5,9 +5,11 @@
* @file efreet_desktop.h
* @brief Contains the structures and methods used to support the
* FDO desktop entry specificiation.
- * @addtogroup Efreet_Desktop Efreet_Desktop: The FDO Desktop Entry
- * Specification functions and structures
- * @ingroup Efreet
+ *
+ * @internal
+ * @defgroup Efreet_Desktop_Group Efreet_Desktop: The FDO Desktop Entry
+ * Specification functions and structures
+ * @ingroup Efreet_Group
*
* @{
*/
@@ -30,12 +32,6 @@ EAPI extern int EFREET_EVENT_DESKTOP_CACHE_UPDATE;
EAPI extern int EFREET_EVENT_DESKTOP_CACHE_BUILD;
/**
- * Efreet_Desktop_Action
- * @since 1.12
- */
-typedef struct _Efreet_Desktop_Action Efreet_Desktop_Action;
-
-/**
* Efreet_Desktop
*/
typedef struct _Efreet_Desktop Efreet_Desktop;
@@ -68,25 +64,11 @@ typedef void (*Efreet_Desktop_Type_Save_Cb) (Efreet_Desktop *desktop, Efreet_Ini
typedef void *(*Efreet_Desktop_Type_Free_Cb) (void *data);
/**
- * Efreet_Desktop_Action
- * @brief an action described in a .desktop file
- * @since 1.12
- */
-struct _Efreet_Desktop_Action
-{
- char *key; /**< Key to identify the action */
- char *name; /**< Specific name of the action */
- char *icon; /**< Icon to display */
- char *exec; /**< Program to execute */
-};
-
-/**
* Efreet_Desktop
* @brief a parsed representation of a .desktop file
*/
struct _Efreet_Desktop
{
- /* Desktop Spec 1.0 */
int type; /**< type of desktop file */
int ref; /**< reference count - internal */
@@ -122,19 +104,10 @@ struct _Efreet_Desktop
Eina_Hash *x; /**< Keep track of all user extensions, keys that begin with X- */
void *type_data; /**< Type specific data for custom types */
-
- /* Desktop Spec 1.1 */
- unsigned char dbus_activatable; /**< Activate application by dbus, not Exec. @since 1.12 */
- Eina_List *actions; /**< List of Efreet_Desktop_Actions, application actions. @since 1.12 */
- Eina_List *implements; /**< Interfaces which is file implements. @since 1.12 */
- Eina_List *keywords; /**< Keywords which describe this entry. @since 1.12 */
};
/**
- * @param file The file to get the Efreet_Desktop from
- * @return Returns a reference to a cached Efreet_Desktop on success, NULL
- * on failure
* @brief Gets a reference to an Efreet_Desktop structure representing the
* contents of @a file or NULL if @a file is not a valid .desktop file.
*
@@ -145,27 +118,30 @@ struct _Efreet_Desktop
* event, if the application is to keep the reference. When the event fires
* the Efreet_Desktop struct should be invalidated and reloaded from a new
* cache file.
+ *
+ * @param[in] file The file to get the Efreet_Desktop from
+ * @return Returns a reference to a cached Efreet_Desktop on success, NULL
+ * on failure
*/
EAPI Efreet_Desktop *efreet_desktop_get(const char *file);
/**
- * @param desktop The Efreet_Desktop to ref
- * @return Returns the new reference count
* @brief Increases reference count on desktop
+ *
+ * @param[in] desktop The Efreet_Desktop to ref
+ * @return Returns the new reference count
*/
EAPI int efreet_desktop_ref(Efreet_Desktop *desktop);
/**
+ * @brief Creates a new empty Efreet_Desktop structure or NULL on failure
+ *
* @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
*/
EAPI Efreet_Desktop *efreet_desktop_empty_new(const char *file);
/**
- * @param file The file to get the Efreet_Desktop from
- * @return Returns a reference to a cached Efreet_Desktop on success, NULL
- * on failure
* @brief Gets a reference to an Efreet_Desktop structure representing the
* contents of @a file or NULL if @a file is not a valid .desktop file.
*
@@ -173,12 +149,14 @@ EAPI Efreet_Desktop *efreet_desktop_empty_new(const char *file);
* event, if the application is to keep the reference. When the event fires
* the Efreet_Desktop struct should be invalidated and reloaded from a new
* cache file.
+ *
+ * @param[in] file The file to get the Efreet_Desktop from
+ * @return Returns a reference to a cached Efreet_Desktop on success, NULL
+ * on failure
*/
EAPI Efreet_Desktop *efreet_desktop_new(const char *file);
/**
- * @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
*
@@ -187,13 +165,17 @@ EAPI Efreet_Desktop *efreet_desktop_new(const char *file);
*
* Data in the structure is allocated with strdup, so use free and strdup to
* change values.
+ *
+ * @param[in] file The file to create the Efreet_Desktop from
+ * @return Returns a new Efreet_Desktop on success, NULL on failure
*/
EAPI Efreet_Desktop *efreet_desktop_uncached_new(const char *file);
/**
- * @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[in] desktop The Efreet_Desktop to work with
+ * @return Returns no value
*/
EAPI void efreet_desktop_free(Efreet_Desktop *desktop);
@@ -205,59 +187,65 @@ EAPI void efreet_desktop_free(Efreet_Desktop *desktop);
/**
- * @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[in] desktop The desktop file to save
+ * @return Returns 1 on success or 0 on failure
*/
EAPI int efreet_desktop_save(Efreet_Desktop *desktop);
/**
- * @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
*
* Please use efreet_desktop_uncached_new() on an existing file
* before using efreet_desktop_save_as()
+ *
+ * @param[in] desktop The desktop file to save
+ * @param[in] file The filename to save as
+ * @return Returns 1 on success or 0 on failure
*/
EAPI int efreet_desktop_save_as(Efreet_Desktop *desktop,
const char *file);
/**
- * @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
- * @brief Parses the @a desktop exec line and runs the command.
+ * @brief Parses the @a desktop exec line and returns an Ecore_Exe.
+ *
+ * @param[in] desktop The desktop file to work with
+ * @param[in] files The files to be substituted into the exec line
+ * @param[in] data The data pointer to pass
+ * @return Returns the Ecore_Exce for @a desktop
*/
EAPI void efreet_desktop_exec(Efreet_Desktop *desktop,
Eina_List *files, void *data);
/**
- * @param environment the environment name
* @brief sets the global desktop environment name
+ *
+ * @param[in] environment the environment name
*/
EAPI void efreet_desktop_environment_set(const char *environment);
/**
+ * @brief sets the global desktop environment name
+ *
* @return environment the environment name
- * @brief gets the global desktop environment name
- * (e.g. "Enlightenment" or "Gnome")
*/
EAPI const char *efreet_desktop_environment_get(void);
/**
- * @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_prog 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.
+ *
+ * @param[in] desktop the desktop entry
+ * @param[in] files an eina list of file names to execute, as either absolute paths,
+ * relative paths, or uris
+ * @param[in] cb_command a callback to call for each prepared command line
+ * @param[in] cb_prog a callback to get progress for the downloads
+ * @param[in] data user data passed to the callback
+ * @return Returns 1 on success or 0 on failure
*/
EAPI void *efreet_desktop_command_progress_get(Efreet_Desktop *desktop,
Eina_List *files,
@@ -265,13 +253,14 @@ EAPI void *efreet_desktop_command_progress_get(Efreet_Desktop *deskt
Efreet_Desktop_Progress_Cb cb_prog,
void *data);
/**
- * @param desktop the desktop entry
- * @param files an eina list of file names to execute, as either absolute paths,
+ * @brief Get a command to use to execute a desktop entry.
+ *
+ * @param[in] desktop the desktop entry
+ * @param[in] 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[in] func a callback to call for each prepared command line
+ * @param[in] 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.
*/
EAPI void *efreet_desktop_command_get(Efreet_Desktop *desktop,
Eina_List *files,
@@ -279,37 +268,41 @@ EAPI void *efreet_desktop_command_get(Efreet_Desktop *desktop,
void *data);
/**
- * @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
*
* The returned list and each of its elements must be freed.
+ *
+ * @param[in] desktop the desktop entry
+ * @param[in] 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
*/
EAPI Eina_List * efreet_desktop_command_local_get(Efreet_Desktop *desktop,
Eina_List *files);
/**
- * @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[in] desktop The desktop to work with
+ * @return Returns the number of categories assigned to this desktop
*/
EAPI unsigned int efreet_desktop_category_count_get(Efreet_Desktop *desktop);
/**
- * @param desktop the desktop
- * @param category the category name
* @brief add a category to a desktop
+ *
+ * @param[in] desktop the desktop
+ * @param[in] category the category name
*/
EAPI void efreet_desktop_category_add(Efreet_Desktop *desktop,
const char *category);
/**
- * @param desktop the desktop
- * @param category the category name
* @brief removes a category from a desktop
+ *
+ * @param[in] desktop the desktop
+ * @param[in] category the category name
* @return 1 if the desktop had his category listed, 0 otherwise
*/
EAPI int efreet_desktop_category_del(Efreet_Desktop *desktop,
@@ -317,12 +310,13 @@ EAPI int efreet_desktop_category_del(Efreet_Desktop *desktop,
/**
- * @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[in] type The type to add to the list of matching types
+ * @param[in] parse_func a function to parse out custom fields
+ * @param[in] save_func a function to save data returned from @a parse_func
+ * @param[in] free_func a function to free data returned from @a parse_func
+ * @return Returns the id of the new type
*/
EAPI int efreet_desktop_type_add(const char *type,
Efreet_Desktop_Type_Parse_Cb parse_func,
@@ -331,8 +325,9 @@ EAPI int efreet_desktop_type_add(const char *type,
/**
* @brief Add an alias for an existing desktop type.
- * @param from_type the type to alias (e.g. EFREE_DESKTOP_TYPE_APPLICATION)
- * @param alias the alias
+ *
+ * @param[in] from_type the type to alias (e.g. EFREE_DESKTOP_TYPE_APPLICATION)
+ * @param[in] alias the alias
* @return the new type id, or -1 if @p from_type was not valid
*
* This allows applications to add non-standard types that behave exactly as standard types.
@@ -342,32 +337,36 @@ EAPI int efreet_desktop_type_alias (int from_type,
/**
* @brief get type specific data for custom desktop types
- * @param desktop the desktop
+ *
+ * @param[in] desktop the desktop
* @return type specific data, or NULL if there is none
*/
EAPI void *efreet_desktop_type_data_get(Efreet_Desktop *desktop);
/**
- * @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[in] string the raw string list
+ * @return an Eina_List of ecore string's
*/
EAPI Eina_List *efreet_desktop_string_list_parse(const char *string);
/**
- * @param list Eina_List with strings
- * @return a raw string list
* @brief Create a ';' separate list of strings according to the desktop spec
+ *
+ * @param[in] list Eina_List with strings
+ * @return a raw string list
*/
EAPI char *efreet_desktop_string_list_join(Eina_List *list);
/**
* @brief Set the value for a X- field (Non spec) in the structure
- * @param desktop the desktop
- * @param key the key name to set
- * @param data the value to set
+ *
+ * @param[in] desktop the desktop
+ * @param[in] key the key name to set
+ * @param[in] data the value to set
* @return EINA_TRUE on success
*
* The key has to start with "X-"
@@ -376,16 +375,18 @@ EAPI Eina_Bool efreet_desktop_x_field_set(Efreet_Desktop *desktop, const
/**
* @brief Get the value for a X- field (Non spec) in the structure
- * @param desktop the desktop
- * @param key the key
+ *
+ * @param[in] desktop the desktop
+ * @param[in] key the key
* @return The value referenced by the key, or NULL if the key does not exist
*/
EAPI const char * efreet_desktop_x_field_get(Efreet_Desktop *desktop, const char *key);
/**
* @brief Delete the key and value for a X- field (Non spec) in the structure
- * @param desktop the desktop
- * @param key the key
+ *
+ * @param[in] desktop the desktop
+ * @param[in] key the key
* @return EINA_TRUE if the key existed
*/
EAPI Eina_Bool efreet_desktop_x_field_del(Efreet_Desktop *desktop, const char *key);
diff --git a/src/lib/efreet/efreet_icon.h b/src/lib/efreet/efreet_icon.h
index 0495622d9b..89a657cdd6 100644
--- a/src/lib/efreet/efreet_icon.h
+++ b/src/lib/efreet/efreet_icon.h
@@ -5,10 +5,12 @@
* @file efreet_icon.h
* @brief Contains the structures and methods used to support the FDO icon
* theme specificiation.
- * @addtogroup Efreet_Icon Efreet_Icon: The FDO Icon Theme
- * Specification functions and structures
*
- * @ingroup Efreet
+ * @internal
+ * @defgroup Efreet_Icon_Group Efreet_Icon: The FDO Icon Theme
+ * Specification functions and structures
+ * @ingroup Efreet_Group
+ *
* @{
*/
@@ -141,77 +143,86 @@ struct Efreet_Icon_Point
};
/**
- * @return Returns the user icon directory
* @brief Returns the user icon directory
+ *
+ * @return Returns the user icon directory
*/
EAPI const char *efreet_icon_user_dir_get(void);
/**
- * @return Returns the deprecated user icon directory
* @brief Returns the deprecated user icon directory
+ *
+ * @return Returns the deprecated user icon directory
*/
EAPI const char *efreet_icon_deprecated_user_dir_get(void);
/**
- * @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[in] ext The extension to add to the list of checked extensions
+ * @return Returns no value.
*/
EAPI void efreet_icon_extension_add(const char *ext);
/**
- * @return Returns a list of strings that are paths to other icon directories
* @brief Gets the list of all extra directories to look for icons. These
* directories are used to look for icons after looking in the user icon dir
* and before looking in standard system directories. The order of search is
* from first to last directory in this list. the strings in the list should
* be created with eina_stringshare_add().
+ *
+ * @return Returns a list of strings that are paths to other icon directories
*/
EAPI Eina_List **efreet_icon_extra_list_get(void);
/**
- * @return Returns a list of strings that are icon extensions to look for
* @brief Gets the list of all icon extensions to look for
+ *
+ * @return Returns a list of strings that are icon extensions to look for
*/
EAPI Eina_List *efreet_icon_extensions_list_get(void);
/**
- * @return Returns a list of Efreet_Icon structs for all the non-hidden icon
- * themes
* @brief Retrieves all of the non-hidden icon themes available on the system.
* The returned list must be freed. Do not free the list data.
+ *
+ * @return Returns a list of Efreet_Icon structs for all the non-hidden icon
+ * themes
*/
EAPI Eina_List *efreet_icon_theme_list_get(void);
/**
- * @param theme_name The theme to look for
+ * @brief Tries to get the icon theme structure for the given theme name
+ *
+ * @param[in] 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
*/
EAPI Efreet_Icon_Theme *efreet_icon_theme_find(const char *theme_name);
/**
- * @param theme_name The icon theme to look for
- * @param icon The icon to look for
- * @param size The icon size to look for
+ * @brief Retrieves all of the information about the given icon.
+ *
+ * @param[in] theme_name The icon theme to look for
+ * @param[in] icon The icon to look for
+ * @param[in] 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.
*/
EAPI Efreet_Icon *efreet_icon_find(const char *theme_name,
const char *icon,
unsigned int size);
/**
- * @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
* @brief Retrieves all of the information about the first found icon in
* the list.
+ *
+ * @param[in] theme_name The icon theme to look for
+ * @param[in] icons List of icons to look for
+ * @param[in] size; The icon size to look for
+ * @return Returns the path representing first found icon or
+ * NULL if none of the icons are found
* @note This function will search the given theme for all icons before falling
* back. This is useful when searching for mimetype icons.
*
@@ -223,12 +234,13 @@ EAPI const char *efreet_icon_list_find(const char *theme_name,
unsigned int size);
/**
- * @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[in] theme_name The icon theme to look for
+ * @param[in] icon The icon to look for
+ * @param[in] size; The icon size to look for
+ * @return Returns the path to the given icon or NULL if none found
+ *
* There is no guarantee for how long the pointer to the path will be valid.
* If the pointer is to be kept, the user must create a copy of the path.
*/
@@ -237,9 +249,10 @@ EAPI const char *efreet_icon_path_find(const char *theme_name,
unsigned int size);
/**
- * @param icon The Efreet_Icon to cleanup
- * @return Returns no value.
* @brief Free's the given icon and all its internal data.
+ *
+ * @param[in] icon The Efreet_Icon to cleanup
+ * @return Returns no value.
*/
EAPI void efreet_icon_free(Efreet_Icon *icon);
diff --git a/src/lib/efreet/efreet_ini.h b/src/lib/efreet/efreet_ini.h
index 2dec08aece..2c242b3745 100644
--- a/src/lib/efreet/efreet_ini.h
+++ b/src/lib/efreet/efreet_ini.h
@@ -5,8 +5,9 @@
* @internal
* @file efreet_ini.h
* @brief A simple and fast INI parser
- * @addtogroup Efreet_Ini Efreet_Ini: An INI parser
- * @ingroup Efreet
+ *
+ * @defgroup Efreet_Ini Efreet_Ini: An INI parser
+ * @ingroup Efreet_Group
*
* @{
*/
@@ -28,150 +29,166 @@ struct Efreet_Ini
/**
- * @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
* @a file, or NULL on failure
+ *
+ * @param[in] 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
*/
EAPI Efreet_Ini *efreet_ini_new(const char *file);
/**
- * @param ini The Efreet_Ini to work with
- * @return Returns no value
* @brief Frees the given Efree_Ini structure.
+ *
+ * @param[in] ini The Efreet_Ini to work with
+ * @return Returns no value
*/
EAPI void efreet_ini_free(Efreet_Ini *ini);
/**
- * @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[in] ini The Efreet_Ini to work with
+ * @param[in] path The file path to load
+ * @return Returns no value
*/
EAPI int efreet_ini_save(Efreet_Ini *ini, const char *path);
/**
- * @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[in] ini The Efreet_Ini to work with
+ * @param[in] section The section of the ini file we want to get values from
+ * @return Returns 1 if the section exists, otherwise 0
*/
EAPI int 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
- * @return Returns no value
* @brief Adds a new working section of the ini file to @a section
+ *
+ * @param[in] ini The Efreet_Ini to work with
+ * @param[in] section The section of the ini file we want to add
+ * @return Returns no value
*/
EAPI void efreet_ini_section_add(Efreet_Ini *ini, const char *section);
/**
- * @param ini The Efree_Ini to work with
- * @param key The key to lookup
+ * @brief Retrieves the value for the given key or NULL if none found.
+ *
+ * @param[in] ini The Efree_Ini to work with
+ * @param[in] 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.
*/
EAPI const char *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
- * @return Returns no value
* @brief Sets the value for the given key
+ *
+ * @param[in] ini The Efree_Ini to work with
+ * @param[in] key The key to use
+ * @param[in] value The value to set
+ * @return Returns no value
*/
EAPI void efreet_ini_string_set(Efreet_Ini *ini, const char *key,
const char *value);
/**
- * @param ini The ini struct to work with
- * @param key The key to search for
+ * @brief Retrieves the utf8 encoded string associated with @a key in the current locale or NULL if none found
+ *
+ * @param[in] ini The ini struct to work with
+ * @param[in] 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
*/
EAPI const char *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
- * @return Returns no value
* @brief Sets the value for the given key
+ *
+ * @param[in] ini The ini struct to work with
+ * @param[in] key The key to use
+ * @param[in] value The value to set
+ * @return Returns no value
*/
EAPI void 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 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[in] ini The ini struct to work with
+ * @param[in] key The key to search for
+ * @return Returns 1 if the boolean is true, 0 otherwise
*/
EAPI unsigned int 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
- * @return Returns no value
* @brief Sets the value for the given key
+ *
+ * @param[in] ini The ini struct to work with
+ * @param[in] key The key to use
+ * @param[in] value The value to set
+ * @return Returns no value
*/
EAPI void efreet_ini_boolean_set(Efreet_Ini *ini, const char *key,
unsigned int value);
/**
- * @param ini The Efree_Ini to work with
- * @param key The key to lookup
+ * @brief Retrieves the value for the given key or -1 if none found.
+ *
+ * @param[in] ini The Efree_Ini to work with
+ * @param[in] 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.
*/
EAPI int 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
- * @return Returns no value
* @brief Sets the value for the given key
+ *
+ * @param[in] ini The Efree_Ini to work with
+ * @param[in] key The key to use
+ * @param[in] value The value to set
+ * @return Returns no value
*/
EAPI void 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
+ * @brief Retrieves the value for the given key or -1 if none found.
+ *
+ * @param[in] ini The Efree_Ini to work with
+ * @param[in] 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.
*/
EAPI double 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
- * @return Returns no value
* @brief Sets the value for the given key
+ *
+ * @param[in] ini The Efree_Ini to work with
+ * @param[in] key The key to use
+ * @param[in] value The value to set
+ * @return Returns no value
*/
EAPI void 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 remove
- * @return Returns no value
* @brief Remove the given key from the ini struct
+ *
+ * @param[in] ini The ini struct to work with
+ * @param[in] key The key to remove
+ * @return Returns no value
*/
EAPI void efreet_ini_key_unset(Efreet_Ini *ini, const char *key);
diff --git a/src/lib/efreet/efreet_menu.h b/src/lib/efreet/efreet_menu.h
index b7f123ac82..de852199ae 100644
--- a/src/lib/efreet/efreet_menu.h
+++ b/src/lib/efreet/efreet_menu.h
@@ -5,9 +5,11 @@
* @file efreet_menu.h
* @brief Contains the structures and methods to support the Desktop
* Menu Specification.
- * @addtogroup Efreet_Menu Efreet_Menu: The FDO Desktop Menu Specification
- * functions and structures
- * @ingroup Efreet
+ *
+ * @internal
+ * @defgroup Efreet_Menu_Group Efreet_Menu: The FDO Desktop Menu Specification
+ * functions and structures
+ * @ingroup Efreet_Group
*
* @{
*/
@@ -42,34 +44,30 @@ struct Efreet_Menu
Efreet_Desktop *desktop; /**< The desktop we refer too */
Eina_List *entries; /**< The menu items */
- int references; /**< refcount (keeps menu util ref is at 0) @since 1.11 */
};
-/**
- * A callback used with efreet_menu_async_get() and efreet_menu_async_parse()
- *
- * @since 1.8
- */
-typedef void (*Efreet_Menu_Cb) (void *data, Efreet_Menu *menu);
/**
- * @return Returns no value
* @brief Initialize legacy kde support. This function blocks while
* the kde-config script is run.
+ *
+ * @return Returns no value
*/
EAPI int efreet_menu_kde_legacy_init(void);
/**
- * @param name The internal name of the menu
+ * @brief Creates a new menu
+ *
+ * @param[in] name The internal name of the menu
* @return Returns the Efreet_Menu on success or
* NULL on failure
- * @brief Creates a new menu
*/
EAPI Efreet_Menu *efreet_menu_new(const char *name);
/**
* @brief Override which file is used for menu creation
- * @param file The file to use for menu creation
+ *
+ * @param[in] 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.
@@ -77,103 +75,72 @@ EAPI Efreet_Menu *efreet_menu_new(const char *name);
EAPI void efreet_menu_file_set(const char *file);
/**
- * Creates the Efreet_Menu representation of the default menu or
- * NULL if none found and returns it in the callback.
- * @param func function to call when menu is created
- * @param data user data to return in callback
+ * @brief Creates the default menu representation
*
- * @since 1.8
- */
-EAPI void efreet_menu_async_get(Efreet_Menu_Cb func, const void *data);
-
-/**
- * @return Returns the Efreet_Menu representation of the default menu or
+ * @return Returns the Efreet_Menu_Internal representation of the default menu or
* NULL if none found
- * @brief Creates the default menu representation
*/
EAPI Efreet_Menu *efreet_menu_get(void);
/**
- * Parses the given .menu file and creates the menu representation, and
- * returns it in the callback
- * @param path The path of the menu to load
- * @param func function to call when menu is created
- * @param data user data to return in callback
+ * @brief Parses the given .menu file and creates the menu representation
*
- * @since 1.8
- */
-EAPI void efreet_menu_async_parse(const char *path, Efreet_Menu_Cb func, const void *data);
-
-/**
- * @param path The path of the menu to load
- * @return Returns the Efreet_Menu representation on success or NULL on
+ * @param[in] 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
*/
EAPI Efreet_Menu *efreet_menu_parse(const char *path);
/**
- * @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[in] menu The menu to work with
+ * @param[in] path The path where the menu should be saved
+ * @return Returns 1 on success, 0 on failure
*/
EAPI int efreet_menu_save(Efreet_Menu *menu, const char *path);
/**
- * @param menu The Efreet_Menu to free
+ * @brief Frees the given structure
+ *
+ * @param[in] menu The Efreet_Menu to free
* @return Returns no value
- * @brief Frees the given structure (if refcount at 1 at the time of this call)
*/
EAPI void efreet_menu_free(Efreet_Menu *menu);
-/**
- * @param menu The Efreet_Menu to reference
- * @return Returns no value
- * @brief Incriments refcount for the menu
- * @since 1.11
- */
-EAPI void efreet_menu_ref(Efreet_Menu *menu);
-
/**
- * @param menu The Efreet_Menu to unreference
- * @return Returns no value
- * @brief Decrements refcount for the menu, and on 0 frees
- * @since 1.11
- */
-EAPI void efreet_menu_unref(Efreet_Menu *menu);
-
-
-/**
- * @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[in] menu The menu to work with
+ * @param[in] desktop The desktop to insert
+ * @param[in] pos The position to place the new desktop
+ * @return Returns 1 on success, 0 on failure
*/
EAPI int 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
- * @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[in] menu The menu to work with
+ * @param[in] desktop The desktop to remove
+ * @return Returns 1 on success, 0 on failure
*/
EAPI int 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
- * @return Returns no value
* @brief Dumps the contents of the menu to the command line
+ *
+ * @param[in] menu The menu to work with
+ * @param[in] menu The menu to work with
+ * @param[in] indent The indent level to print the menu at
+ * @return Returns no value
*/
EAPI void efreet_menu_dump(Efreet_Menu *menu, const char *indent);
diff --git a/src/lib/efreet/efreet_uri.h b/src/lib/efreet/efreet_uri.h
index 32b1f51ad2..4b59c37ea7 100644
--- a/src/lib/efreet/efreet_uri.h
+++ b/src/lib/efreet/efreet_uri.h
@@ -4,8 +4,11 @@
/**
* @file efreet_uri.h
* @brief Contains the methods used to support the FDO URI specification.
- * @addtogroup Efreet_Uri Efreet_Uri: The FDO URI Specification functions
- * @ingroup Efreet
+ *
+ * @internal
+ * @defgroup Efreet_Uri_Group Efreet_Uri: The FDO URI Specification functions
+ * @ingroup Efreet_Group
+ *
* @{
*/
@@ -30,28 +33,31 @@ struct Efreet_Uri
/**
- * @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()
* when you don't need it anymore.
+ *
+ * @param[in] uri Create an URI string from an Efreet_Uri struct
+ * @return The string rapresentation of uri (ex: 'file:///home/my%20name')
* @note The resulting string will contain the protocol and the path but not
* the hostname, as many apps doesn't handle it.
*/
EAPI const char *efreet_uri_encode(Efreet_Uri *uri);
/**
- * @param val 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
* escaped chars will be converted to normal.
+ *
+ * @param[in] val a valid uri string to parse
+ * @return Return The corresponding Efreet_Uri structure. Or NULL on errors.
*/
EAPI Efreet_Uri *efreet_uri_decode(const char *val);
/**
- * @param uri The uri to free
* @brief Free the given uri structure.
+ *
+ * @param[in] uri The uri to free
*/
EAPI void efreet_uri_free(Efreet_Uri *uri);
diff --git a/src/lib/efreet/efreet_utils.h b/src/lib/efreet/efreet_utils.h
index aef0511eea..5af80554bd 100644
--- a/src/lib/efreet/efreet_utils.h
+++ b/src/lib/efreet/efreet_utils.h
@@ -5,8 +5,10 @@
* @file efreet_utils.h
* @brief Contains utility functions to ease usage of Efreet.
* FDO desktop entry specificiation.
- * @addtogroup Efreet_Utils Efreet utilities for FDO
- * @ingroup Efreet
+ *
+ * @internal
+ * @defgroup Efreet_Utils_Group Efreet utilities for FDO
+ * @ingroup Efreet_Group
*
* @{
*/
@@ -16,7 +18,7 @@
* Returns the fdo file id for a given path. If the file isn't inside
* a default fdo path it will return NULL.
*
- * @param path The path to find the file id for
+ * @param[in] path The path to find the file id for
*
* @return File id for path or NULL
*/
@@ -28,7 +30,7 @@ EAPI const char *efreet_util_path_to_file_id(const char *path);
*
* This list must be freed using EINA_LIST_FREE / efreet_desktop_free
*
- * @param mime the mime type
+ * @param[in] mime the mime type
* @return a list of desktops
*/
EAPI Eina_List *efreet_util_desktop_mime_list(const char *mime);
@@ -39,8 +41,8 @@ EAPI Eina_List *efreet_util_desktop_mime_list(const char *mime);
*
* This list must be freed using EINA_LIST_FREE / efreet_desktop_free
*
- * @param wmname the wm name
- * @param wmclass the wm class
+ * @param[in] wmname the wm name
+ * @param[in] wmclass the wm class
* @return a list of desktops
*/
EAPI Efreet_Desktop *efreet_util_desktop_wm_class_find(const char *wmname, const char *wmclass);
@@ -50,7 +52,7 @@ EAPI Efreet_Desktop *efreet_util_desktop_wm_class_find(const char *wmname, const
*
* return value must be freed by efreet_desktop_free
*
- * @param file_id the file id
+ * @param[in] file_id the file id
* @return a desktop
*/
EAPI Efreet_Desktop *efreet_util_desktop_file_id_find(const char *file_id);
@@ -60,7 +62,7 @@ EAPI Efreet_Desktop *efreet_util_desktop_file_id_find(const char *file_id);
*
* return value must be freed by efreet_desktop_free
*
- * @param exec the exec name
+ * @param[in] exec the exec name
* @return a desktop
*/
EAPI Efreet_Desktop *efreet_util_desktop_exec_find(const char *exec);
@@ -70,7 +72,7 @@ EAPI Efreet_Desktop *efreet_util_desktop_exec_find(const char *exec);
*
* return value must be freed by efreet_desktop_free
*
- * @param name the name
+ * @param[in] name the name
* @return a desktop
*/
EAPI Efreet_Desktop *efreet_util_desktop_name_find(const char *name);
@@ -80,7 +82,7 @@ EAPI Efreet_Desktop *efreet_util_desktop_name_find(const char *name);
*
* return value must be freed by efreet_desktop_free
*
- * @param generic_name the generic name
+ * @param[in] generic_name the generic name
* @return a desktop
*/
EAPI Efreet_Desktop *efreet_util_desktop_generic_name_find(const char *generic_name);
@@ -91,7 +93,7 @@ EAPI Efreet_Desktop *efreet_util_desktop_generic_name_find(const char *generic_n
*
* This list must be freed using EINA_LIST_FREE / efreet_desktop_free
*
- * @param glob the pattern to match
+ * @param[in] glob the pattern to match
* @return a list of desktops
*/
EAPI Eina_List *efreet_util_desktop_name_glob_list(const char *glob);
@@ -101,7 +103,7 @@ EAPI Eina_List *efreet_util_desktop_name_glob_list(const char *glob);
*
* This list must be freed using EINA_LIST_FREE / efreet_desktop_free
*
- * @param glob the pattern to match
+ * @param[in] glob the pattern to match
* @return a list of desktops
*/
EAPI Eina_List *efreet_util_desktop_exec_glob_list(const char *glob);
@@ -111,7 +113,7 @@ EAPI Eina_List *efreet_util_desktop_exec_glob_list(const char *glob);
*
* This list must be freed using EINA_LIST_FREE / efreet_desktop_free
*
- * @param glob the pattern to match
+ * @param[in] glob the pattern to match
* @return a list of desktops
*/
EAPI Eina_List *efreet_util_desktop_generic_name_glob_list(const char *glob);
@@ -121,7 +123,7 @@ EAPI Eina_List *efreet_util_desktop_generic_name_glob_list(const char *glob);
*
* This list must be freed using EINA_LIST_FREE / efreet_desktop_free
*
- * @param glob the pattern to match
+ * @param[in] glob the pattern to match
* @return a list of desktops
*/
EAPI Eina_List *efreet_util_desktop_comment_glob_list(const char *glob);
@@ -140,7 +142,7 @@ EAPI Eina_List *efreet_util_desktop_categories_list(void);
*
* This list must be freed using EINA_LIST_FREE / efreet_desktop_free
*
- * @param category the category name
+ * @param[in] category the category name
* @return a list of desktops
*/
EAPI Eina_List *efreet_util_desktop_category_list(const char *category);
@@ -148,21 +150,12 @@ EAPI Eina_List *efreet_util_desktop_category_list(const char *category);
/**
* Returns a list of .menu files found in the various config dirs.
+ *
* @return An eina list of menu file paths (const char *). This must be freed with EINA_LIST_FREE.
*/
EAPI Eina_List *efreet_util_menus_find(void);
/**
- * Find all known desktop environments
- * This list must be freed using EINA_LIST_FREE
- * @since 1.12
- *
- * @return an Eina_List of desktop environments names (const char *)
- */
-EAPI Eina_List *efreet_util_desktop_environments_list(void);
-
-
-/**
* @}
*/
#endif