[gtksourceview] Document the version macros



commit 98298716c71dc055dcf7141ee70150cb35b5161e
Author: Paolo Borelli <pborelli gnome org>
Date:   Tue Dec 8 14:29:02 2015 +0100

    Document the version macros

 docs/reference/gtksourceview-3.0-sections.txt |    9 ++
 gtksourceview/gtksourceversion.h.in           |  102 ++++++++++++++++++++++++-
 2 files changed, 109 insertions(+), 2 deletions(-)
---
diff --git a/docs/reference/gtksourceview-3.0-sections.txt b/docs/reference/gtksourceview-3.0-sections.txt
index d16d369..1629029 100644
--- a/docs/reference/gtksourceview-3.0-sections.txt
+++ b/docs/reference/gtksourceview-3.0-sections.txt
@@ -849,6 +849,15 @@ GTK_SOURCE_MINOR_VERSION
 GTK_SOURCE_MICRO_VERSION
 GTK_SOURCE_CHECK_VERSION
 <SUBSECTION>
+GTK_SOURCE_VERSION_3_0
+GTK_SOURCE_VERSION_3_2
+GTK_SOURCE_VERSION_3_4
+GTK_SOURCE_VERSION_3_8
+GTK_SOURCE_VERSION_3_10
+GTK_SOURCE_VERSION_3_12
+GTK_SOURCE_VERSION_3_14
+GTK_SOURCE_VERSION_3_18
+GTK_SOURCE_VERSION_3_20
 GTK_SOURCE_VERSION_MIN_REQUIRED
 GTK_SOURCE_VERSION_MAX_ALLOWED
 </SECTION>
diff --git a/gtksourceview/gtksourceversion.h.in b/gtksourceview/gtksourceversion.h.in
index 150e0cf..7c174af 100644
--- a/gtksourceview/gtksourceversion.h.in
+++ b/gtksourceview/gtksourceversion.h.in
@@ -83,16 +83,114 @@ G_BEGIN_DECLS
 #define _GTK_SOURCE_EXTERN extern
 #endif
 
+/**
+ * GTK_SOURCE_VERSION_3_0:
+ *
+ * A macro that evaluates to the 3.0 version of GtkSourceView,
+ * in a format that can be used by the C pre-processor.
+ *
+ * Since: 3.20
+ */
 #define GTK_SOURCE_VERSION_3_0 (G_ENCODE_VERSION (3, 0))
+
+/**
+ * GTK_SOURCE_VERSION_3_2:
+ *
+ * A macro that evaluates to the 3.2 version of GtkSourceView,
+ * in a format that can be used by the C pre-processor.
+ *
+ * Since: 3.20
+ */
 #define GTK_SOURCE_VERSION_3_2 (G_ENCODE_VERSION (3, 2))
+
+/**
+ * GTK_SOURCE_VERSION_3_4:
+ *
+ * A macro that evaluates to the 3.4 version of GtkSourceView,
+ * in a format that can be used by the C pre-processor.
+ *
+ * Since: 3.20
+ */
 #define GTK_SOURCE_VERSION_3_4 (G_ENCODE_VERSION (3, 4))
+
+/**
+ * GTK_SOURCE_VERSION_3_6:
+ *
+ * A macro that evaluates to the 3.6 version of GtkSourceView,
+ * in a format that can be used by the C pre-processor.
+ *
+ * Since: 3.20
+ */
 #define GTK_SOURCE_VERSION_3_6 (G_ENCODE_VERSION (3, 6))
+
+/**
+ * GTK_SOURCE_VERSION_3_8:
+ *
+ * A macro that evaluates to the 3.8 version of GtkSourceView,
+ * in a format that can be used by the C pre-processor.
+ *
+ * Since: 3.20
+ */
 #define GTK_SOURCE_VERSION_3_8 (G_ENCODE_VERSION (3, 8))
+
+/**
+ * GTK_SOURCE_VERSION_3_10:
+ *
+ * A macro that evaluates to the 3.10 version of GtkSourceView,
+ * in a format that can be used by the C pre-processor.
+ *
+ * Since: 3.20
+ */
 #define GTK_SOURCE_VERSION_3_10 (G_ENCODE_VERSION (3, 10))
+
+/**
+ * GTK_SOURCE_VERSION_3_12:
+ *
+ * A macro that evaluates to the 3.12 version of GtkSourceView,
+ * in a format that can be used by the C pre-processor.
+ *
+ * Since: 3.20
+ */
 #define GTK_SOURCE_VERSION_3_12 (G_ENCODE_VERSION (3, 12))
+
+/**
+ * GTK_SOURCE_VERSION_3_14:
+ *
+ * A macro that evaluates to the 3.14 version of GtkSourceView,
+ * in a format that can be used by the C pre-processor.
+ *
+ * Since: 3.20
+ */
 #define GTK_SOURCE_VERSION_3_14 (G_ENCODE_VERSION (3, 14))
+
+/**
+ * GTK_SOURCE_VERSION_3_16:
+ *
+ * A macro that evaluates to the 3.16 version of GtkSourceView,
+ * in a format that can be used by the C pre-processor.
+ *
+ * Since: 3.20
+ */
 #define GTK_SOURCE_VERSION_3_16 (G_ENCODE_VERSION (3, 16))
+
+/**
+ * GTK_SOURCE_VERSION_3_18:
+ *
+ * A macro that evaluates to the 3.18 version of GtkSourceView,
+ * in a format that can be used by the C pre-processor.
+ *
+ * Since: 3.20
+ */
 #define GTK_SOURCE_VERSION_3_18 (G_ENCODE_VERSION (3, 18))
+
+/**
+ * GTK_SOURCE_VERSION_3_20:
+ *
+ * A macro that evaluates to the 3.20 version of GtkSourceView,
+ * in a format that can be used by the C pre-processor.
+ *
+ * Since: 3.20
+ */
 #define GTK_SOURCE_VERSION_3_20 (G_ENCODE_VERSION (3, 20))
 
 #if (GTK_SOURCE_MINOR_VERSION % 2)
@@ -112,7 +210,7 @@ G_BEGIN_DECLS
  *
  * A macro that should be defined by the user prior to including
  * the gtksource.h header.
- * The definition should be one of the predefined GDK version
+ * The definition should be one of the predefined version
  * macros: %GTK_SOURCE_VERSION_3_0, %GTK_SOURCE_VERSION_3_2,...
  *
  * This macro defines the lower bound for the GtkSourceView API to use.
@@ -132,7 +230,7 @@ G_BEGIN_DECLS
  *
  * A macro that should be defined by the user prior to including
  * the gtksource.h header.
- * The definition should be one of the predefined GDK version
+ * The definition should be one of the predefined version
  * macros: %GTK_SOURCE_VERSION_3_0, %GTK_SOURCE_VERSION_3_2,...
  *
  * This macro defines the upper bound for the GtkSourceView API to use.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]