X-Git-Url: https://www.fi.muni.cz/~kas/git//home/kas/public_html/git/?a=blobdiff_plain;ds=inline;f=libdocument%2Fev-version.h.in;h=97cf0a981d3a98cf3e69e0c4b799eae1055a72ca;hb=212d9a536bc60e711b779feb5e8aa33db654997d;hp=2601622ef0122100d226ba1bd64744b3f28760c9;hpb=1086dfad6d63d9aa737934f4dae75c3f14fdc804;p=evince.git

diff --git a/libdocument/ev-version.h.in b/libdocument/ev-version.h.in
index 2601622e..97cf0a98 100644
--- a/libdocument/ev-version.h.in
+++ b/libdocument/ev-version.h.in
@@ -13,16 +13,54 @@
  *
  * You should have received a copy of the GNU Lesser General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place, Suite 330, Boston, MA 02110-1301  USA
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  */
 
 #ifndef EV_VERSION_H
 #define EV_VERSION_H
 
+/**
+ * SECTION:ev-version
+ * @short_description: Library version checks
+ *
+ * These macros enable compile time checks of the library version.
+ */
+
+/**
+ * EV_MAJOR_VERSION:
+ *
+ * The major version number of the EV library
+ * (e.g. in version 3.1.4 this is 3).
+ */
+
 #define EV_MAJOR_VERSION (@EV_MAJOR_VERSION@)
+
+/**
+ * EV_MINOR_VERSION:
+ *
+ * The minor version number of the EV library
+ * (e.g. in version 3.1.4 this is 1).
+ */
 #define EV_MINOR_VERSION (@EV_MINOR_VERSION@)
+
+/**
+ * EV_MICRO_VERSION:
+ *
+ * The micro version number of the EV library
+ * (e.g. in version 3.1.4 this is 4).
+ */
 #define EV_MICRO_VERSION (@EV_MICRO_VERSION@)
 
+/**
+ * EV_CHECK_VERSION:
+ * @major: required major version
+ * @minor: required minor version
+ * @micro: required micro version
+ *
+ * Macro to check the library version at compile time.
+ * It returns <literal>1</literal> if the version of EV is greater or
+ * equal to the required one, and <literal>0</literal> otherwise.
+ */
 #define EV_CHECK_VERSION(major,minor,micro) \
   (EV_MAJOR_VERSION > (major) || \
    (EV_MAJOR_VERSION == (major) && EV_MINOR_VERSION > (minor)) || \