bsls_bsldeprecationinformation

Detailed Description

Provide a macro to control bsl deprecations by release version.

Outline

• Purpose
• Macros
• Description
  • NOT A MODEL; DO NOT EMULATE
  • Usage

Purpose

Provide a macro to control bsl deprecations by release version.

Macros

• BSL_VERSION_DEPRECATION_THRESHOLD: activate deprecations by bsl version

See also

bsls_deprecate

Description

This component provides a macro, BSL_VERSION_DEPRECATION_THRESHOLD, that is used to control whether or not deprecations introduced in any given version of bsl are active.

NOT A MODEL; DO NOT EMULATE

This component exists only because the structure of bsl is NON-STANDARD, which prevents us from defining the deprecation threshold macro in bslscm, where it normally would belong. Other UORs should NOT use this component as a model. Please see bsls_deprecate and the version tag components in other, standard-conforming, BDE UORs such as bdlscm_versiontag .

Usage

There is no usage example for this component since it is not meant for direct client use.

Macro Definition Documentation

BSL_VERSION_DEPRECATION_THRESHOLD

#define BSL_VERSION_DEPRECATION_THRESHOLD   BSLS_DEPRECATE_MAKE_VER(3, 1)

Declare that deprecations for this UOR introduced in the specified version or earlier will be "active" by default – i.e., BSLS_DEPRECATE_IS_ACTIVE will be true (which typically enables deprecation warnings).

Note

Note that we define this macro in this special component, so that it is available at the lowest level in the component hierarchy of this UOR.