[docs] Modernise API docs

Use no-tmpl gtk-doc option.
Use xi:include, add index and object hierarchy, etc.

1 files changed, 38 insertions, 0 deletions

diff --git a/libdocument/ev-version.h.in b/libdocument/ev-version.h.in
index 2601622..bdad6f7 100644
--- a/libdocument/ev-version.h.in
+++ b/libdocument/ev-version.h.in
@@ -19,10 +19,48 @@
 #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)) || \