VTK-m  1.8
Macros
Deprecated.h File Reference
#include <vtkm/StaticAssert.h>
#include <vtkm/Types.h>

Go to the source code of this file.

Macros

#define VTK_M_DEPRECATED_MAKE_MESSAGE(...)   VTKM_EXPAND(VTK_M_DEPRECATED_MAKE_MESSAGE_IMPL(__VA_ARGS__, "", vtkm::internal::NullType{}))
 
#define VTK_M_DEPRECATED_MAKE_MESSAGE_IMPL(version, message, ...)   message " Deprecated in version " #version "."
 
#define VTKM_DEPRECATED_SUPPRESS_BEGIN
 
#define VTKM_DEPRECATED_SUPPRESS_END
 
#define VTKM_DEPRECATED(...)
 

Macro Definition Documentation

◆ VTK_M_DEPRECATED_MAKE_MESSAGE

#define VTK_M_DEPRECATED_MAKE_MESSAGE (   ...)    VTKM_EXPAND(VTK_M_DEPRECATED_MAKE_MESSAGE_IMPL(__VA_ARGS__, "", vtkm::internal::NullType{}))

◆ VTK_M_DEPRECATED_MAKE_MESSAGE_IMPL

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

◆ VTKM_DEPRECATED

#define VTKM_DEPRECATED (   ...)

Classes and methods are marked deprecated using the VTKM_DEPRECATED macro. The first argument of VTKM_DEPRECATED should be set to the first version in which the feature is deprecated. For example, if the last released version of VTK-m was 1.5, and on the master branch a developer wants to deprecate a class foo, then the VTKM_DEPRECATED release version should be given as 1.6, which will be the next minor release of VTK-m. The second argument of VTKM_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.

◆ VTKM_DEPRECATED_SUPPRESS_BEGIN

#define VTKM_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 VTKM_DEPRECATED_SUPPRESS_BEGIN must be paired with a VTKM_DEPRECATED_SUPPRESS_END, which will re-enable warnings in subsequent code.

Do not use a semicolon after this macro.

◆ VTKM_DEPRECATED_SUPPRESS_END

#define VTKM_DEPRECATED_SUPPRESS_END

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

Do not use a semicolon after this macro.