libixp

git clone git://oldgit.suckless.org/libixp/
Log | Files | Refs | LICENSE

IXP_API.3 (1131B)


      1 .TH "IXP_API" 3 "2010 Jun" "libixp Manual"
      2 
      3 .SH NAME
      4 .P
      5 IXP_API, IXP_NEEDAPI, IXP_MAXAPI, IXP_ASSERT_VERSION
      6 
      7 .SH SYNOPSIS
      8 .nf
      9   #include <ixp.h>
     10   
     11   #define IXP_API ...
     12   
     13   #define IXP_NEEDAPI ...
     14   
     15   #define IXP_MAXAPI ...
     16   
     17   #define IXP_ASSERT_VERSION ...
     18 .fi
     19 
     20 .SH DESCRIPTION
     21 .P
     22 IXP_API contains the current libixp API revision number.
     23 
     24 .P
     25 IXP_NEEDAPI, if defined before ixp.h is included, directs the
     26 header to present an older version of the libixp API. This allows
     27 code written for older versions of libixp to compile against
     28 newer versions without modification. It does not, however, ensure
     29 that it will link against a different version of libixp than the
     30 ixp.h header belongs to.
     31 
     32 .P
     33 IXP_MAXAPI, if defined before ixp.h is included, prevents code
     34 from compiling with a newer version of libixp than specified.
     35 
     36 .P
     37 When inserted into any function, IXP_ASSERT_VERSION ensures that
     38 the resulting object will fail to link link against any version
     39 of libixp with a different API version than it was compiled
     40 against.
     41 
     42 
     43 .\" man code generated by txt2tags 2.5 (http://txt2tags.sf.net)
     44 .\" cmdline: txt2tags -o- IXP_API.man3
     45