aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/efreet/Efreet_Mime.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/efreet/Efreet_Mime.h')
-rw-r--r--src/lib/efreet/Efreet_Mime.h83
1 files changed, 48 insertions, 35 deletions
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);