summaryrefslogtreecommitdiff
path: root/src/lib/evas/Evas_Common.h
diff options
context:
space:
mode:
authorNicolas Aguirre <aguirre.nicolas@gmail.com>2014-10-10 11:45:02 +0200
committerCedric BAIL <cedric@osg.samsung.com>2014-10-20 18:01:23 +0200
commit554efc015a79f40a98fef7beae1e7d5d3843c0bb (patch)
tree665a4b3a399f4df84e242bd4274bc75b25728006 /src/lib/evas/Evas_Common.h
parentf8db9a85fb0d878026f4b3e3e0e8f263a272c624 (diff)
evas: add documentation for Evas_Version structure.
Diffstat (limited to 'src/lib/evas/Evas_Common.h')
-rw-r--r--src/lib/evas/Evas_Common.h30
1 files changed, 26 insertions, 4 deletions
diff --git a/src/lib/evas/Evas_Common.h b/src/lib/evas/Evas_Common.h
index 6826c79b72..f9a517d8cf 100644
--- a/src/lib/evas/Evas_Common.h
+++ b/src/lib/evas/Evas_Common.h
@@ -5,12 +5,34 @@
5#define EVAS_VERSION_MAJOR EFL_VERSION_MAJOR 5#define EVAS_VERSION_MAJOR EFL_VERSION_MAJOR
6#define EVAS_VERSION_MINOR EFL_VERSION_MINOR 6#define EVAS_VERSION_MINOR EFL_VERSION_MINOR
7 7
8/**
9 * @typedef Evas_Version
10 *
11 * This is the Evas version information structure that can be used at
12 * runtime to detect which version of evas is being used and adapt
13 * appropriately as follows for example:
14 *
15 * @code
16 * #if defined(EVAS_VERSION_MAJOR) && (EVAS_VERSION_MAJOR >= 1) && defined(EVAS_VERSION_MINOR) && (EVAS_VERSION_MINOR > 0)
17 * printf("Evas version: %i.%i.%i\n",
18 * evas_version->major,
19 * evas_version->minor,
20 * evas_version->micro);
21 * if (evas_version->revision > 0)
22 * {
23 * printf(" Built from Git revision # %i\n", evas_version->revision);
24 * }
25 * #endif
26 * @endcode
27 *
28 */
29
8typedef struct _Evas_Version 30typedef struct _Evas_Version
9{ 31{
10 int major; 32 int major; /** < major (binary or source incompatible changes) */
11 int minor; 33 int minor; /** < minor (new features, bugfixes, major improvements version) */
12 int micro; 34 int micro; /** < micro (bugfix, internal improvements, no new features version) */
13 int revision; 35 int revision; /** < git revision (0 if a proper release or the git revision number Evas is built from) */
14} Evas_Version; 36} Evas_Version;
15 37
16EAPI extern Evas_Version * evas_version; 38EAPI extern Evas_Version * evas_version;