Skip to main content

Deprecated.h File

Compiler-portable deprecation macros used framework-wide. More...

Macro Definitions Index​

#defineSIMA_DEPRECATED(msg)

Mark a symbol as deprecated with an explanatory message. More...

Description​

Compiler-portable deprecation macros used framework-wide.

Defines SIMA_DEPRECATED(msg). When SIMA_ENABLE_LEGACY_DEPRECATION is defined the macro expands to the appropriate compiler attribute (__declspec(deprecated) on MSVC, __attribute__((deprecated)) on GCC/Clang) so call sites generate deprecation warnings; otherwise it expands to nothing so production builds remain warning-free. Headers can pre-define SIMA_DEPRECATED themselves to override this default.

Macro Definitions​

SIMA_DEPRECATED​

#define SIMA_DEPRECATED(msg)

Mark a symbol as deprecated with an explanatory message.

Usage: SIMA_DEPRECATED("Use Foo() instead") void OldFoo();. Expands to a compiler-specific deprecation attribute when SIMA_ENABLE_LEGACY_DEPRECATION is set, otherwise expands to nothing.

Parameters
msg

String literal explaining what to use instead.

Definition at line 35 of file Deprecated.h.

35#define SIMA_DEPRECATED(msg)

File Listing​

The file content with the documentation metadata removed is:

1
13#pragma once
14
25#if !defined(SIMA_DEPRECATED)
26#if defined(SIMA_ENABLE_LEGACY_DEPRECATION)
27#if defined(_MSC_VER)
28#define SIMA_DEPRECATED(msg) __declspec(deprecated(msg))
29#elif defined(__GNUC__) || defined(__clang__)
30#define SIMA_DEPRECATED(msg) __attribute__((deprecated(msg)))
31#else
32#define SIMA_DEPRECATED(msg)
33#endif
34#else
35#define SIMA_DEPRECATED(msg)
36#endif
37#endif

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.