doc/deprecated.doxygen

Code
Comments
Other
Rev Date Author Line
2579 05 Oct 11 peter 1 // $Id$
2579 05 Oct 11 peter 2 //
4359 23 Aug 23 peter 3 // Copyright (C) 2011 Peter Johansson
2579 05 Oct 11 peter 4 //
2579 05 Oct 11 peter 5 // This file is part of the yat library, http://dev.thep.lu.se/yat
2579 05 Oct 11 peter 6 //
2579 05 Oct 11 peter 7 // The yat library is free software; you can redistribute it and/or
2579 05 Oct 11 peter 8 // modify it under the terms of the GNU General Public License as
2579 05 Oct 11 peter 9 // published by the Free Software Foundation; either version 3 of the
2579 05 Oct 11 peter 10 // License, or (at your option) any later version.
2579 05 Oct 11 peter 11 //
2579 05 Oct 11 peter 12 // The yat library is distributed in the hope that it will be useful,
2579 05 Oct 11 peter 13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
2579 05 Oct 11 peter 14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2579 05 Oct 11 peter 15 // General Public License for more details.
2579 05 Oct 11 peter 16 //
2579 05 Oct 11 peter 17 // You should have received a copy of the GNU General Public License
2579 05 Oct 11 peter 18 // along with yat. If not, see <http://www.gnu.org/licenses/>.
2579 05 Oct 11 peter 19
2579 05 Oct 11 peter 20
2579 05 Oct 11 peter 21 /**
2703 12 Mar 12 peter 22 \page yat_deprecate YAT_DEPRECATE
2579 05 Oct 11 peter 23
2579 05 Oct 11 peter 24 Sometimes it may be necassary to remove a function or a class. In this
2579 05 Oct 11 peter 25 case the function or class will first be declared \c deprecated and
2579 05 Oct 11 peter 26 removed in a later version. If you try to use a <a
2579 05 Oct 11 peter 27 href=deprecated.html>deprecated function or class</a> and you use
2579 05 Oct 11 peter 28 GCC (or any other compiler that supports GCC like deprecations), the
2579 05 Oct 11 peter 29 compiler will warn you that you are using deprecated
2579 05 Oct 11 peter 30 functionality. You can disable these warnings by defining \c
2579 05 Oct 11 peter 31 YAT_DEPRECATE before including the header file in question
2579 05 Oct 11 peter 32
2579 05 Oct 11 peter 33 \verbatim
2579 05 Oct 11 peter 34 #define YAT_DEPRECATE
2579 05 Oct 11 peter 35 #include <yat/utility/foo.h>
2579 05 Oct 11 peter 36 \endverbatim
2579 05 Oct 11 peter 37
2579 05 Oct 11 peter 38 */

Generated on Sat Oct 14 02:20:19 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)