deprecation.h File Reference

Control display of deprecation information. More...

Include dependency graph for deprecation.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	IMP
	The IMP kernel provides base classes and key shared functionality.
Defines
#define	IMP_DEPRECATED(old_classname, replacement_classname)
	Mark the class as deprecated. It will print out a message.
#define	IMP_DEPRECATED_WARN
Functions
void	IMP::set_print_deprecation_messages (bool tf)
	Toggle printing of warnings on using deprecated classes.

---

Detailed Description

Control display of deprecation information.

Copyright 2007-2010 IMP Inventors. All rights reserved.

---

Define Documentation

#define IMP_DEPRECATED	(	old_classname,
		replacement_classname		)

Mark the class as deprecated. It will print out a message.

From time to time, IMP is updated in ways that break backward compatibility. In certain cases we will leave the old functionality in so as not to break existing code which uses IMP. Such code is said to be "deprecated". See the deprecated class list for a list of such classes.

Deprecated classes are marked in a variety of ways:

• They are listed in the "Deprecated List" in the "Related Pages" tab.
• They are noted as deprecated in their documentation.
• They print a warning when an instance is constructed or the function is called.

The warnings can be turned off using the IMP::core::set_print_deprecation_messages function.

Parameters:

[in]	old_classname	The class which is deprecated.
[in]	replacement_classname	The class which replaces it.

Further, IMP can be built without deprecated code by defining IMP_NO_DEPRECATED or the deprecated=False scons argument.

You should also use the

Deprecated:

command in the doxygen documentation.