Fix documentation build under maverick (doxygen 1.7.1)
[senf.git] / senf / Utils / IgnoreValue.hh
1 // $Id$
2 //
3 // Copyright (C) 2010
4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
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 IgnoreValue public header */
25
26 #ifndef HH_SENF_senf_Utils_IgnoreValue_
27 #define HH_SENF_senf_Utils_IgnoreValue_ 1
28
29 // Custom includes
30
31 //#include "IgnoreValue.mpp"
32 //-/////////////////////////////////////////////////////////////////////////////////////////////////
33
34 namespace senf {
35
36     /** \brief Explicitly ignore a value
37
38         To explicitly ingore a value (e.g. the return value of a function), pass that value to
39         senf::IGNORE(). This has the added benefit of silencing \em any warnings about ignored
40         values by g++.
41      */
42     template <class T>
43     void IGNORE(T const &);
44     template <class T>
45     void IGNORE(T const *);
46
47 }
48
49 //-/////////////////////////////////////////////////////////////////////////////////////////////////
50 //#include "IgnoreValue.cci"
51 //#include "IgnoreValue.ct"
52 #include "IgnoreValue.cti"
53 #endif
54
55 \f
56 // Local Variables:
57 // mode: c++
58 // fill-column: 100
59 // comment-column: 40
60 // c-file-style: "senf"
61 // indent-tabs-mode: nil
62 // ispell-local-dictionary: "american"
63 // compile-command: "scons -u test"
64 // End: