aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/efreet/Efreet.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/efreet/Efreet.h')
-rw-r--r--src/lib/efreet/Efreet.h95
1 files changed, 40 insertions, 55 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