// $Id$
//
// Copyright (C) 2011, 2012 Peter Johansson
//
// This file is part of the yat library, http://dev.thep.lu.se/yat
//
// The yat library is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 3 of the
// License, or (at your option) any later version.
//
// The yat library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with yat. If not, see <http://www.gnu.org/licenses/>.


/**
\page yat_deprecate YAT_DEPRECATE

Sometimes it may be necassary to remove a function or a class. In this
case the function or class will first be declared \c deprecated and
removed in a later version. If you try to use a <a
href=deprecated.html>deprecated function or class</a> and you use
GCC (or any other compiler that supports GCC like deprecations), the
compiler will warn you that you are using deprecated
functionality. You can disable these warnings by defining \c
YAT_DEPRECATE before including the header file in question

\verbatim
#define YAT_DEPRECATE
#include <yat/utility/foo.h>
\endverbatim

*/