From ce16fdcf62c6f991d52c708e42d9d0c15b68b804 Mon Sep 17 00:00:00 2001 From: Claudio Saavedra Date: Wed, 17 Jun 2009 09:40:06 +0300 Subject: [PATCH] Document versioning macros * doc/hildon-docs.sgml: Add hildon-version section. * doc/hildon-sections.txt: * hildon/hildon-version.h.in: Document versioning macros and add HILDON_VERSION. --- ChangeLog | 7 +++++++ doc/hildon-docs.sgml | 1 + doc/hildon-sections.txt | 2 ++ hildon/hildon-version.h.in | 41 +++++++++++++++++++++++++++++++++++++++++ 4 files changed, 51 insertions(+) diff --git a/ChangeLog b/ChangeLog index 61c13f5..b96168a 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,12 @@ 2009-06-17 Claudio Saavedra + * doc/hildon-docs.sgml: Add hildon-version section. + * doc/hildon-sections.txt: + * hildon/hildon-version.h.in: Document versioning macros and + add HILDON_VERSION. + +2009-06-17 Claudio Saavedra + * doc/hildon-sections.txt: Remove HILDON_DISABLE_DEPRECATED from HildonPickerDialog section. diff --git a/doc/hildon-docs.sgml b/doc/hildon-docs.sgml index 6f49b97..1acbe77 100644 --- a/doc/hildon-docs.sgml +++ b/doc/hildon-docs.sgml @@ -75,6 +75,7 @@ + diff --git a/doc/hildon-sections.txt b/doc/hildon-sections.txt index fcfa334..6b0cad3 100644 --- a/doc/hildon-sections.txt +++ b/doc/hildon-sections.txt @@ -1215,9 +1215,11 @@ HildonTouchSelectorEntryClass
hildon-version +Versioning Macros HILDON_MAJOR_VERSION HILDON_MINOR_VERSION HILDON_MICRO_VERSION +HILDON_VERSION HILDON_CHECK_VERSION
diff --git a/hildon/hildon-version.h.in b/hildon/hildon-version.h.in index 6fec0ff..b311e61 100644 --- a/hildon/hildon-version.h.in +++ b/hildon/hildon-version.h.in @@ -22,13 +22,54 @@ * */ +/** + * SECTION:hildon-version + * @short_description: Versioning utility macros + * + * Hildon offers a set of macros for checking the version of the library + * an application was linked to. + */ + #ifndef __HILDON_VERSION_H__ #define __HILDON_VERSION_H__ +/** + * HILDON_MAJOR_VERSION: + * + * The major version of the Hildon library (1, if %HILDON_VERSION is 1.2.3) + */ #define HILDON_MAJOR_VERSION (@PACKAGE_VERSION_MAJOR@) + +/** + * HILDON_MINOR_VERSION: + * + * The minor version of the Hildon library (2, if %HILDON_VERSION is 1.2.3) + */ #define HILDON_MINOR_VERSION (@PACKAGE_VERSION_MINOR@) + +/** + * HILDON_MICRO_VERSION: + * + * The micro version of the Hildon library (3, if %HILDON_VERSION is 1.2.3) + */ #define HILDON_MICRO_VERSION (@PACKAGE_VERSION_MICRO@) +/** + * HILDON_VERSION: + * + * The full version of the Hildon library, like 1.2.3 + */ +#define HILDON_VERSION (@PACKAGE_VERSION@) + +/** + * HILDON_CHECK_VERSION: + * @major: major version, like 1 in 1.2.3 + * @minor: minor version, like 2 in 1.2.3 + * @micro: micro version, like 3 in 1.2.3 + * + * Evaluates to %TRUE if the version of the Hildon library is greater + * than @major, @minor and @micro + */ #define HILDON_CHECK_VERSION(major,minor,micro) \ (HILDON_MAJOR_VERSION > (major) || \ (HILDON_MAJOR_VERSION == (major) && HILDON_MINOR_VERSION > (minor)) || \ -- 1.7.9.5