Utils: Revamp documentation overview and add some missing docs
[senf.git] / Utils / auto_unit_test.hh
1 // $Id$
2 //
3 // Copyright (C) 2007 
4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
5 // Kompetenzzentrum fuer NETwork research (NET)
6 //     Stefan Bund <g0dil@berlios.de>
7 //
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2 of the License, or
11 // (at your option) any later version.
12 //
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 // GNU General Public License for more details.
17 //
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22
23 /** \file
24     \brief Boost.Test auto unit test compatibility across Boost V 1.33 and 1.34
25
26     This header file will allows to consistently use the Boost Version 1.33 syntax for defining auto
27     unit tests. If the available Boost version is 1.34, this file will automatically take care of
28     any necessary workarounds.
29
30     So, instead of <tt>#include <boost/test/auto_unit_test.hpp></tt>, you should always write
31     <tt>#include "../Utils/auto_unit_test.hh"<tt> (with possibliy adjusted path).
32  */
33
34 #ifndef HH_auto_unit_test_
35 #define HH_auto_unit_test_ 1
36
37 // Custom includes
38 #include <boost/version.hpp>
39
40 //#include "auto_unit_test.mpp"
41 ///////////////////////////////hh.p////////////////////////////////////////
42
43 #if BOOST_VERSION >= 103400
44
45 #   define BOOST_AUTO_UNIT_TEST BOOST_AUTO_TEST_CASE
46
47 #endif
48
49 #include <boost/test/auto_unit_test.hpp>
50
51 ///////////////////////////////hh.e////////////////////////////////////////
52 //#include "auto_unit_test.cci"
53 //#include "auto_unit_test.ct"
54 //#include "auto_unit_test.cti"
55 #endif
56
57 \f
58 // Local Variables:
59 // mode: c++
60 // fill-column: 100
61 // comment-column: 40
62 // c-file-style: "senf"
63 // indent-tabs-mode: nil
64 // ispell-local-dictionary: "american"
65 // compile-command: "scons -u test"
66 // End: