From 429c1982d4751facab94027200d553fc4af3bdd8 Mon Sep 17 00:00:00 2001 From: jzmaddock Date: Wed, 22 Feb 2023 19:08:52 +0000 Subject: [PATCH] Documentation update. [CI SKIP] --- .../boost_config/boost_macro_reference.html | 227 +++++++++++++----- doc/html/index.html | 6 +- doc/macro_reference.qbk | 16 -- 3 files changed, 172 insertions(+), 77 deletions(-) diff --git a/doc/html/boost_config/boost_macro_reference.html b/doc/html/boost_config/boost_macro_reference.html index 8948684b..cbaa2828 100644 --- a/doc/html/boost_config/boost_macro_reference.html +++ b/doc/html/boost_config/boost_macro_reference.html @@ -33,8 +33,6 @@ that describe C++03 defects
Macros that describe optional features
-
Macros - that describe possible C++ future features
Macros that describe C++11 features not supported
Macros @@ -2559,46 +2557,6 @@
-

- The following macros describe features that may be included in some future - ISO C++ standard, but have not yet been approved for inclusion in the language. -

-
---- - - - - - - - - -
-

- Macro -

- 		-

- Description -

-
-

- BOOST_HAS_CONCEPTS -

- 		-

- The compiler supports concepts. -

-
-
-
-
@@ -2650,6 +2608,19 @@ + +

+ BOOST_NO_CXX11_ALIGNOF +

+ + +

+ The compiler does not support the alignof + keyword. +

+ + +

BOOST_NO_CXX11_ALLOCATOR @@ -2915,7 +2886,9 @@

- The standard library does not provide header <codecvt>. + The standard library does not provide header <codecvt>. Note + that this header is deprecated post C++17, and therefore the macro + may be set as a result of the feature being deliberately removed.

@@ -3805,6 +3778,19 @@

+ + +

+ BOOST_NULLPTR +

+ + +

+ If BOOST_NO_CXX11_NULLPTR + is not defined (i.e. C++11 compliant compilers), expands to nullptr, otherwise expands to 0. +

+ +
@@ -4222,6 +4208,19 @@

+ + +

+ BOOST_NO_CXX17_DEDUCTION_GUIDES +

+ + +

+ The compiler does not support class template argument deduction + (CTAD) guides. +

+ + @@ -4356,7 +4355,7 @@

- The compiler does not support the header <format>. + The compiler does not support the header <source_location>.

@@ -4452,7 +4451,7 @@

- The compiler does not support the header <range>. + The compiler does not support the header <ranges>.

@@ -4492,6 +4491,18 @@

+ + +

+ BOOST_NO_CXX20_HDR_VERSION +

+ + +

+ The compiler does not support the header <version>. +

+ + @@ -4590,6 +4601,19 @@

+ + +

+ BOOST_NO_CXX11_HDR_CODECVT +

+ + +

+ The standard library no longer supports <codecvt>, + there is as yet no replacement. +

+ + @@ -4824,8 +4848,8 @@ case 41: if (truth_is_out_there) { ++x; - BOOST_FALLTHROUGH; // Use instead of/along with annotations in - // comments. + BOOST_FALLTHROUGH; // Use instead of/along with annotations in + // comments. } else { return x; } @@ -5017,14 +5041,13 @@

- This macro can be used in place of the compiler specific variant + This macro can be used in place of the compiler-specific variant of the C99 restrict keyword to notify the compiler that, for the lifetime of the qualified - pointer variable, only it and its derivative value will be used - to gain access to the object it references. This limits the effect - of pointer aliasing and helps the optimizers in generating better - code. However, i this condition is violated, undefined behavior - may occurs. + pointer variable, only it and its derivative values will be used + to access the object it references. This limits the effect of pointer + aliasing and helps optimizers in generating better code. However, + if this condition is violated, undefined behavior may occur.

Usage example: @@ -5235,6 +5258,45 @@ + +

+ BOOST_DEPRECATED(M) +

+ + +

+ Expands to an attribute for a symbol that generates warnings when + that symbol is used in code. The warnings may contain a message + M, which must be + a string literal. This attribute may be applied to types, functions + or objects and is typically used to mark parts of the API as deprecated + with a recommendation of replacement. +

+

+ Example: +

+
BOOST_DEPRECATED("Use bar() instead.")
+void foo();
+
+template< typename T >
+class BOOST_DEPRECATED("Use std::unique_ptr instead.") auto_ptr
+{
+};
+
+BOOST_DEPRECATED("Use std::numeric_limits<int>::max() instead.")
+const int max_int = 0x7fffffff;
+
+

+

+

+ The warnings issued by BOOST_DEPRECATED + can be suppressed by defining BOOST_ALLOW_DEPRECATED_SYMBOLS + or BOOST_ALLOW_DEPRECATED + macros. +

+ + +

BOOST_PRAGMA_MESSAGE(M) @@ -5278,7 +5340,9 @@

The messages issued by BOOST_HEADER_DEPRECATED - can be suppressed by defining the macro BOOST_ALLOW_DEPRECATED_HEADERS. + can be suppressed by defining BOOST_ALLOW_DEPRECATED_HEADERS + or BOOST_ALLOW_DEPRECATED + macros.

@@ -5476,6 +5540,29 @@ + +

+ BOOST_CLANG_VERSION +

+ + +

+ <boost/config.hpp> +

+ + +

+ Defined to the version of the Clang compiler, usually __clang_major__ * + 10000 + + __clang_minor__ * + 100 + + __clang_patchlevel__. + On Apple Clang, has a best-effort value reflecting the upstream + version, rather than the Apple version. +

+ + +

BOOST_BORLANDC @@ -5568,18 +5655,22 @@

- BOOST_NO_WREGEX + BOOST_MSSTL_VERSION

- <boost/regex.hpp> + <boost/config.hpp>

- Defined if the regex library does not support wide character regular - expressions. + Defined if the Microsoft Visual C++ standard library is in use. + Has the value of _MSVC_STL_VERSION + when that is defined, and a synthesized value of the same format + otherwise. Example values are 143 for VS2022/msvc-14.3, 142 for + VS2019/msvc-14.2, 141 for VS2017/msvc-14.1, 140 for VS2015/msvc-14.0, + 120 for VS2013/msvc-12.0, and so on.

@@ -6859,6 +6950,26 @@

+ + +

+ BOOST_DISABLE_EXPLICIT_SYMBOL_VISIBILITY +

+ + +

+ Disables the effect of the BOOST_SYMBOL_EXPORT, BOOST_SYMBOL_IMPORT + and BOOST_SYMBOL_VISIBLE macros, in order to revert to the default + compiler behaviour. Note that this option should never be used + if Boost libraries are being linking against dynamically, or + if you are building a shared library that exposes Boost types + in its public API. It is however advisable when statically-linking + against Boost to prevent Boost symbols from leaking from the + binary: for instance because you are building a plug-in for a + software which may itself use Boost which could cause ODR conflicts. +

+ +

diff --git a/doc/html/index.html b/doc/html/index.html index 3b318f82..f67daac9 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -58,12 +58,12 @@

Boost Macro Reference
+
Broad + C++ Standard Level Checks
Macros that describe C++03 defects
Macros that describe optional features
-
Macros - that describe possible C++ future features
Macros that describe C++11 features not supported
Macros @@ -992,7 +992,7 @@ - +

Last revised: March 05, 2021 at 17:51:35 GMT

Last revised: February 22, 2023 at 19:02:21 GMT
diff --git a/doc/macro_reference.qbk b/doc/macro_reference.qbk index 9a2d1565..b9da79f0 100644 --- a/doc/macro_reference.qbk +++ b/doc/macro_reference.qbk @@ -630,22 +630,6 @@ standard). [endsect] -[section Macros that describe possible C++ future features] - -The following macros describe features that may be included in some future -ISO C++ standard, but have not yet been approved for inclusion in the language. - - -[table -[[Macro ][Description ]] - -[[`BOOST_HAS_CONCEPTS`][ -The compiler supports concepts. -]] -] - -[endsect] - [section Macros that describe C++11 features not supported] The following macros describe features in the 2011 ISO C++ standard, formerly known as C++0x,