BDE 4.39.x Production Release
Loading...
Searching...
No Matches
bsls_bsldeprecationinformation.h
Go to the documentation of this file.
1/// @file bsls_bsldeprecationinformation.h
2///
3/// The content of this file has been pre-processed for Doxygen.
4///
5
6
7// bsls_bsldeprecationinformation.h -*-C++-*-
8#ifndef INCLUDED_BSLS_BSLDEPRECATIONINFORMATION
9#define INCLUDED_BSLS_BSLDEPRECATIONINFORMATION
10
11/// @defgroup bsls_bsldeprecationinformation bsls_bsldeprecationinformation
12/// @brief Provide a macro to control `bsl` deprecations by release version.
13/// @addtogroup bsl
14/// @{
15/// @addtogroup bsls
16/// @{
17/// @addtogroup bsls_bsldeprecationinformation
18/// @{
19///
20/// <h1> Outline </h1>
21/// * <a href="#bsls_bsldeprecationinformation-purpose"> Purpose</a>
22/// * <a href="#bsls_bsldeprecationinformation-macros"> Macros </a>
23/// * <a href="#bsls_bsldeprecationinformation-description"> Description </a>
24/// * <a href="#bsls_bsldeprecationinformation-not-a-model-do-not-emulate"> NOT A MODEL; DO NOT EMULATE </a>
25/// * <a href="#bsls_bsldeprecationinformation-usage"> Usage </a>
26///
27/// # Purpose {#bsls_bsldeprecationinformation-purpose}
28/// Provide a macro to control `bsl` deprecations by release version.
29///
30/// # Macros {#bsls_bsldeprecationinformation-macros}
31///
32/// - BSL_VERSION_DEPRECATION_THRESHOLD: activate deprecations by `bsl` version
33///
34/// @see bsls_deprecate
35///
36/// # Description {#bsls_bsldeprecationinformation-description}
37/// This component provides a macro,
38/// `BSL_VERSION_DEPRECATION_THRESHOLD`, that is used to control whether or not
39/// deprecations introduced in any given version of `bsl` are active.
40///
41/// ## NOT A MODEL; DO NOT EMULATE {#bsls_bsldeprecationinformation-not-a-model-do-not-emulate}
42///
43///
44/// This component exists only because the structure of `bsl` is *NON-STANDARD*,
45/// which prevents us from defining the deprecation threshold macro in `bslscm`,
46/// where it normally would belong. Other UORs should *NOT* use this component
47/// as a model. Please see @ref bsls_deprecate and the version tag components in
48/// other, standard-conforming, BDE UORs such as @ref bdlscm_versiontag .
49///
50/// ## Usage {#bsls_bsldeprecationinformation-usage}
51///
52///
53/// There is no usage example for this component since it is not meant for
54/// direct client use.
55/// @}
56/** @} */
57/** @} */
58
59/** @addtogroup bsl
60 * @{
61 */
62/** @addtogroup bsls
63 * @{
64 */
65/** @addtogroup bsls_bsldeprecationinformation
66 * @{
67 */
68
69// BDE_VERIFY pragma: push
70// BDE_VERIFY pragma: -SLM01
71
72/// Declare that deprecations for this UOR introduced in the specified
73/// version or earlier will be "active" by default -- i.e.,
74/// `BSLS_DEPRECATE_IS_ACTIVE` will be `true` (which typically enables deprecation warnings).
75///
76/// \note Note that we define this macro in this special
77/// component, so that it is available at the lowest level in the component
78/// hierarchy of this UOR.
79#define BSL_VERSION_DEPRECATION_THRESHOLD BSLS_DEPRECATE_MAKE_VER(3, 1)
80
81// BDE_VERIFY pragma: pop
82
83#endif // INCLUDED_BSLS_BSLDEPRECATIONINFORMATION
84
85// ----------------------------------------------------------------------------
86// Copyright 2017 Bloomberg Finance L.P.
87//
88// Licensed under the Apache License, Version 2.0 (the "License");
89// you may not use this file except in compliance with the License.
90// You may obtain a copy of the License at
91//
92// http://www.apache.org/licenses/LICENSE-2.0
93//
94// Unless required by applicable law or agreed to in writing, software
95// distributed under the License is distributed on an "AS IS" BASIS,
96// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
97// See the License for the specific language governing permissions and
98// limitations under the License.
99// ----------------------------- END-OF-FILE ----------------------------------
100
101/** @} */
102/** @} */
103/** @} */