#include <viskores/StaticAssert.h>
#include <viskores/Types.h>

Macros
#define	VISKORES_DEPRECATED_MAKE_MESSAGE(...)

#define	VISKORES_DEPRECATED_MAKE_MESSAGE_IMPL(version, message, ...) message " Deprecated in version " #version "."

#define	VISKORES_DEPRECATED_SUPPRESS_BEGIN

#define	VISKORES_DEPRECATED_SUPPRESS_END

#define	VISKORES_DEPRECATED(...)

Macro Definition Documentation

◆ VISKORES_DEPRECATED

#define VISKORES_DEPRECATED ( ... )

Classes and methods are marked deprecated using the VISKORES_DEPRECATED macro. The first argument of VISKORES_DEPRECATED should be set to the first version in which the feature is deprecated. For example, if the last released version of Viskores was 1.5, and on the master branch a developer wants to deprecate a class foo, then the VISKORES_DEPRECATED release version should be given as 1.6, which will be the next minor release of Viskores. The second argument of VISKORES_DEPRECATED, which is optional but highly encouraged, is a short message that should clue developers on how to update their code to the new changes. For example, it could point to the replacement class or method for the changed feature.

◆ VISKORES_DEPRECATED_MAKE_MESSAGE

#define VISKORES_DEPRECATED_MAKE_MESSAGE ( ... )

Value:

VISKORES_EXPAND( \

VISKORES_DEPRECATED_MAKE_MESSAGE_IMPL(__VA_ARGS__, "", viskores::internal::NullType{}))

◆ VISKORES_DEPRECATED_MAKE_MESSAGE_IMPL

#define VISKORES_DEPRECATED_MAKE_MESSAGE_IMPL	(	version,
		message,
		...
	)	message " Deprecated in version " #version "."

◆ VISKORES_DEPRECATED_SUPPRESS_BEGIN

#define VISKORES_DEPRECATED_SUPPRESS_BEGIN

Begins a region of code in which warnings about using deprecated code are ignored. Such suppression is usually helpful when implementing other deprecated features. (You would think if one deprecated method used another deprecated method this would not be a warning, but it is.)

Any use of VISKORES_DEPRECATED_SUPPRESS_BEGIN must be paired with a VISKORES_DEPRECATED_SUPPRESS_END, which will re-enable warnings in subsequent code.

Do not use a semicolon after this macro.

◆ VISKORES_DEPRECATED_SUPPRESS_END

#define VISKORES_DEPRECATED_SUPPRESS_END

Ends a region of code in which warnings about using deprecated code are ignored. Any use of VISKORES_DEPRECATED_SUPPRESS_BEGIN must be paired with a VISKORES_DEPRECATED_SUPPRESS_END.