ethumb: add documentation for Ethumb_Version structure.
authorNicolas Aguirre <aguirre.nicolas@gmail.com>
Fri, 10 Oct 2014 10:17:12 +0000 (12:17 +0200)
committerCedric BAIL <cedric@osg.samsung.com>
Mon, 20 Oct 2014 16:02:07 +0000 (18:02 +0200)
src/lib/ethumb/Ethumb.h

index 4f91433..6a1bd40 100644 (file)
@@ -36,13 +36,16 @@ extern "C" {
 
 #define ETHUMB_VERSION_MAJOR EFL_VERSION_MAJOR
 #define ETHUMB_VERSION_MINOR EFL_VERSION_MINOR
-   
+   /**
+    * @typedef Ethumb_Version
+    * Represents the current version of Ethumb
+    */
    typedef struct _Ethumb_Version
      {
-        int major;
-        int minor;
-        int micro;
-        int revision;
+        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 Ethumb is built from) */
      } Ethumb_Version;
 
    EAPI extern Ethumb_Version *ethumb_version;