ceph/src/boost/libs/vmd/doc/vmd_introduction.qbk

   1 [/
   2   (C) Copyright Edward Diener 2011-2015
   3   Distributed under the Boost Software License, Version 1.0.
   4   (See accompanying file LICENSE_1_0.txt or copy at
   5   http://www.boost.org/LICENSE_1_0.txt).
   6 ]
   7
   8 [section:vmd_intro Introduction]
   9
  10 Welcome to version 1.9 of the Variadic Macro Data library.
  11
  12 The Variadic Macro Data library, referred to hereafter as VMD for
  13 short, is a library of variadic macros which provide enhancements
  14 to the functionality in the Boost preprocessor library ( Boost PP ),
  15 especially as it relates to preprocessor "data types".
  16
  17 The functionality of the library may be summed up as:
  18
  19 # Provide a better way of testing for and using empty parameters and empty preprocessor data.
  20 # Provide ways for testing/parsing for identifiers, numbers, types, tuples, arrays, lists, and seqs.
  21 # Provide ways for testing/parsing sequences of identifiers, numbers, types, tuples, arrays, lists. and seqs.
  22 # Provide some useful variadic macros not in Boost PP.
  23
  24 The library is a header only library and all macros in the
  25 library are included by a single header, whose name is 'vmd.hpp'.
  26 Individual headers may be used for different functionality
  27 in the library and will be denoted when that functionality is
  28 explained.
  29
  30 All the macros in the library begin with the sequence 'BOOST_VMD_'
  31 to distinguish them from other macros the end-user might use. Therefore
  32 the end-user should not use any C++ identifiers, whether in macros or
  33 otherwise, which being with the sequence 'BOOST_VMD_'.
  34
  35 Use of the library is only dependent on Boost PP. The library also
  36 uses Boost detail lightweight_test.hpp for its own tests.
  37
  38 [endsect]