SuppressWarning.hh File Reference

#include <gz/utils/detail/SuppressWarning.hh>

Go to the source code of this file.

Macros
#define	GZ_UTILS_WARN_IGNORE__DEPRECATED_DECLARATION    DETAIL_GZ_UTILS_WARN_IGNORE__DEPRECATED_DECLARATION
	Use this to suppress deprecation warnings. This may be useful when retaining tests for deprecated methods to preserve code coverage.
#define	GZ_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING    DETAIL_GZ_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
	Microsoft Visual Studio does not automatically export the interface information for member variables that belong to interface classes of a DLL. Instead it issues this warning. When the member variable is private, we choose to suppress the warning instead of needlessly adding the class information to the DLL interface.
#define	GZ_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR    DETAIL_GZ_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR
	Compilers might warn about deleting a pointer to a class that has virtual functions without a virtual destructor or a final declaration, because the pointer might secretly be pointing to a more derived class type. We want to suppress this warning when we know for certain (via the design of our implementation) that the pointer is definitely not pointing to a more derived type.
#define	GZ_UTILS_WARN_IGNORE__SWITCH_NO_DEFAULT_STATEMENT    DETAIL_GZ_UTILS_WARN_IGNORE__SWITCH_NO_DEFAULT_STATEMENT
	Use this to suppress warnings for switch without a default statement. This can be useful when using code that relies on not having a default to trigger missing case warnings when a new enum variant is added.
#define	GZ_UTILS_WARN_RESUME__DEPRECATED_DECLARATION    DETAIL_GZ_UTILS_WARN_RESUME__DEPRECATED_DECLARATION
#define	GZ_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING    DETAIL_GZ_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
#define	GZ_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR    DETAIL_GZ_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR
#define	GZ_UTILS_WARN_RESUME__SWITCH_NO_DEFAULT_STATEMENT    DETAIL_GZ_UTILS_WARN_RESUME__SWITCH_NO_DEFAULT_STATEMENT

Macro Definition Documentation

GZ_UTILS_WARN_IGNORE__DEPRECATED_DECLARATION

#define GZ_UTILS_WARN_IGNORE__DEPRECATED_DECLARATION    DETAIL_GZ_UTILS_WARN_IGNORE__DEPRECATED_DECLARATION

Use this to suppress deprecation warnings. This may be useful when retaining tests for deprecated methods to preserve code coverage.

GZ_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING

#define GZ_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING    DETAIL_GZ_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING

Microsoft Visual Studio does not automatically export the interface information for member variables that belong to interface classes of a DLL. Instead it issues this warning. When the member variable is private, we choose to suppress the warning instead of needlessly adding the class information to the DLL interface.

GZ_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR

#define GZ_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR    DETAIL_GZ_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR

Compilers might warn about deleting a pointer to a class that has virtual functions without a virtual destructor or a final declaration, because the pointer might secretly be pointing to a more derived class type. We want to suppress this warning when we know for certain (via the design of our implementation) that the pointer is definitely not pointing to a more derived type.

GZ_UTILS_WARN_IGNORE__SWITCH_NO_DEFAULT_STATEMENT

#define GZ_UTILS_WARN_IGNORE__SWITCH_NO_DEFAULT_STATEMENT    DETAIL_GZ_UTILS_WARN_IGNORE__SWITCH_NO_DEFAULT_STATEMENT

Use this to suppress warnings for switch without a default statement. This can be useful when using code that relies on not having a default to trigger missing case warnings when a new enum variant is added.

GZ_UTILS_WARN_RESUME__DEPRECATED_DECLARATION

#define GZ_UTILS_WARN_RESUME__DEPRECATED_DECLARATION    DETAIL_GZ_UTILS_WARN_RESUME__DEPRECATED_DECLARATION

GZ_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING

#define GZ_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING    DETAIL_GZ_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING

GZ_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR

#define GZ_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR    DETAIL_GZ_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR

GZ_UTILS_WARN_RESUME__SWITCH_NO_DEFAULT_STATEMENT

#define GZ_UTILS_WARN_RESUME__SWITCH_NO_DEFAULT_STATEMENT    DETAIL_GZ_UTILS_WARN_RESUME__SWITCH_NO_DEFAULT_STATEMENT