docs/tmpl/pango-version.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Version Checking
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Tools for checking Pango version at compile- and run-time.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The capital-letter macros defined here can be used to check the version of
  10 Pango at compile-time, and to <firstterm>encode</firstterm> Pango versions into
  11 integers.
  12
  13 The functions can be used to check the version of the linked Pango library
  14 at run-time.
  15 </para>
  16
  17 <!-- ##### SECTION See_Also ##### -->
  18 <para>
  19
  20 </para>
  21
  22 <!-- ##### SECTION Stability_Level ##### -->
  23
  24
  25 <!-- ##### MACRO PANGO_VERSION_ENCODE ##### -->
  26 <para>
  27 This macro encodes the given Pango version into an integer.  The numbers
  28 returned by %PANGO_VERSION and pango_version() are encoded using this macro.
  29 Two encoded version numbers can be compared as integers.
  30 </para>
  31
  32 @major: the major component of the version number
  33 @minor: the minor component of the version number
  34 @micro: the micro component of the version number
  35
  36
  37 <!-- ##### MACRO PANGO_VERSION ##### -->
  38 <para>
  39 The version of Pango available at compile-time, encoded using
  40 PANGO_VERSION_ENCODE().
  41 </para>
  42
  43
  44
  45 <!-- ##### MACRO PANGO_VERSION_MAJOR ##### -->
  46 <para>
  47 The major component of the version of Pango available at compile-time.
  48 </para>
  49
  50
  51
  52 <!-- ##### MACRO PANGO_VERSION_MINOR ##### -->
  53 <para>
  54 The minor component of the version of Pango available at compile-time.
  55 </para>
  56
  57
  58
  59 <!-- ##### MACRO PANGO_VERSION_MICRO ##### -->
  60 <para>
  61 The micro component of the version of Pango available at compile-time.
  62 </para>
  63
  64
  65
  66 <!-- ##### MACRO PANGO_VERSION_STRING ##### -->
  67 <para>
  68 A string literal containing the version of Pango available at compile-time.
  69 </para>
  70
  71
  72
  73 <!-- ##### MACRO PANGO_VERSION_CHECK ##### -->
  74 <para>
  75 Checks that the version of Pango available at compile-time is not older than
  76 the provided version number.
  77 </para>
  78
  79 @major: the major component of the version number
  80 @minor: the minor component of the version number
  81 @micro: the micro component of the version number
  82
  83
  84 <!-- ##### FUNCTION pango_version ##### -->
  85 <para>
  86
  87 </para>
  88
  89 @Returns:
  90
  91
  92 <!-- ##### FUNCTION pango_version_string ##### -->
  93 <para>
  94
  95 </para>
  96
  97 @Returns:
  98
  99
 100 <!-- ##### FUNCTION pango_version_check ##### -->
 101 <para>
 102
 103 </para>
 104
 105 @required_major:
 106 @required_minor:
 107 @required_micro:
 108 @Returns:
 109
 110