source: trunk/doc/deprecated.doxygen @ 2632

Last change on this file since 2632 was 2579, checked in by Peter, 10 years ago

document YAT_DEPRECATED. closes #675

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