1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="json-glib-Versioning-information">
<refmeta>
<refentrytitle role="top_of_page" id="json-glib-Versioning-information.top_of_page">Versioning information</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>JSON-GLIB Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Versioning information</refname>
<refpurpose>JSON-GLib version checking</refpurpose>
</refnamediv>
<refsynopsisdiv id="json-glib-Versioning-information.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#define <link linkend="JSON-MAJOR-VERSION--CAPS">JSON_MAJOR_VERSION</link>
#define <link linkend="JSON-MINOR-VERSION--CAPS">JSON_MINOR_VERSION</link>
#define <link linkend="JSON-MICRO-VERSION--CAPS">JSON_MICRO_VERSION</link>
#define <link linkend="JSON-VERSION--CAPS">JSON_VERSION</link>
#define <link linkend="JSON-VERSION-S--CAPS">JSON_VERSION_S</link>
#define <link linkend="JSON-VERSION-HEX--CAPS">JSON_VERSION_HEX</link>
#define <link linkend="JSON-CHECK-VERSION--CAPS">JSON_CHECK_VERSION</link> (major,minor,micro)
</synopsis>
</refsynopsisdiv>
<refsect1 id="json-glib-Versioning-information.description" role="desc">
<title role="desc.title">Description</title>
<para>
JSON-GLib provides macros to check the version of the library
at compile-time</para>
<para>
</para>
</refsect1>
<refsect1 id="json-glib-Versioning-information.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="JSON-MAJOR-VERSION--CAPS" role="macro">
<title>JSON_MAJOR_VERSION</title>
<indexterm zone="JSON-MAJOR-VERSION--CAPS"><primary sortas="MAJOR_VERSION">JSON_MAJOR_VERSION</primary></indexterm><programlisting>#define JSON_MAJOR_VERSION (0)
</programlisting>
<para>
Json major version component (e.g. 1 if <link linkend="JSON-VERSION--CAPS"><literal>JSON_VERSION</literal></link> is 1.2.3)</para>
<para>
</para></refsect2>
<refsect2 id="JSON-MINOR-VERSION--CAPS" role="macro">
<title>JSON_MINOR_VERSION</title>
<indexterm zone="JSON-MINOR-VERSION--CAPS"><primary sortas="MINOR_VERSION">JSON_MINOR_VERSION</primary></indexterm><programlisting>#define JSON_MINOR_VERSION (10)
</programlisting>
<para>
Json minor version component (e.g. 2 if <link linkend="JSON-VERSION--CAPS"><literal>JSON_VERSION</literal></link> is 1.2.3)</para>
<para>
</para></refsect2>
<refsect2 id="JSON-MICRO-VERSION--CAPS" role="macro">
<title>JSON_MICRO_VERSION</title>
<indexterm zone="JSON-MICRO-VERSION--CAPS"><primary sortas="MICRO_VERSION">JSON_MICRO_VERSION</primary></indexterm><programlisting>#define JSON_MICRO_VERSION (2)
</programlisting>
<para>
Json micro version component (e.g. 3 if <link linkend="JSON-VERSION--CAPS"><literal>JSON_VERSION</literal></link> is 1.2.3)</para>
<para>
</para></refsect2>
<refsect2 id="JSON-VERSION--CAPS" role="macro">
<title>JSON_VERSION</title>
<indexterm zone="JSON-VERSION--CAPS"><primary sortas="VERSION">JSON_VERSION</primary></indexterm><programlisting>#define JSON_VERSION (0.10.2)
</programlisting>
<para>
Json version.</para>
<para>
</para></refsect2>
<refsect2 id="JSON-VERSION-S--CAPS" role="macro">
<title>JSON_VERSION_S</title>
<indexterm zone="JSON-VERSION-S--CAPS"><primary sortas="VERSION_S">JSON_VERSION_S</primary></indexterm><programlisting>#define JSON_VERSION_S "0.10.2"
</programlisting>
<para>
Json version, encoded as a string, useful for printing and
concatenation.</para>
<para>
</para></refsect2>
<refsect2 id="JSON-VERSION-HEX--CAPS" role="macro">
<title>JSON_VERSION_HEX</title>
<indexterm zone="JSON-VERSION-HEX--CAPS"><primary sortas="VERSION_HEX">JSON_VERSION_HEX</primary></indexterm><programlisting>#define JSON_VERSION_HEX</programlisting>
<para>
Json version, encoded as an hexadecimal number, useful for
integer comparisons.</para>
<para>
</para></refsect2>
<refsect2 id="JSON-CHECK-VERSION--CAPS" role="macro">
<title>JSON_CHECK_VERSION()</title>
<indexterm zone="JSON-CHECK-VERSION--CAPS"><primary sortas="CHECK_VERSION">JSON_CHECK_VERSION</primary></indexterm><programlisting>#define JSON_CHECK_VERSION(major,minor,micro)</programlisting>
<para>
Compile-time version checking. Evaluates to <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the version
of Json is greater than the required one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>major</parameter> :</term>
<listitem><simpara> required major version
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>minor</parameter> :</term>
<listitem><simpara> required minor version
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>micro</parameter> :</term>
<listitem><simpara> required micro version
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
