feedc0de/boost_config
1
0
Fork 0
forked from boostorg/config
Code Pull Requests Activity

Documentation update.

Browse Source 
[CI SKIP]
This commit is contained in:
jzmaddock
2023-02-22 19:08:52 +00:00
parent ab271393a7
commit 429c1982d4
3 changed files with 172 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

227
doc/html/boost_config/boost_macro_reference.html
View File

@@ -33,8 +33,6 @@
that describe C++03 defects</a></span></dt> that describe C++03 defects</a></span></dt>
<dt><span class="section"><a href="boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_describe_optional_features">Macros <dt><span class="section"><a href="boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_describe_optional_features">Macros
that describe optional features</a></span></dt> that describe optional features</a></span></dt>
<dt><span class="section"><a href="boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_describe_possible_c___future_features">Macros
that describe possible C++ future features</a></span></dt>
<dt><span class="section"><a href="boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_describe_c__11_features_not_supported">Macros <dt><span class="section"><a href="boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_describe_c__11_features_not_supported">Macros
that describe C++11 features not supported</a></span></dt> that describe C++11 features not supported</a></span></dt>
<dt><span class="section"><a href="boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_allow_use_of_c__11_features_with_c__03_compilers">Macros <dt><span class="section"><a href="boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_allow_use_of_c__11_features_with_c__03_compilers">Macros
@@ -2559,46 +2557,6 @@
</div> </div>
<div class="section"> <div class="section">
<div class="titlepage"><div><div><h3 class="title"> <div class="titlepage"><div><div><h3 class="title">
<a name="boost_config.boost_macro_reference.macros_that_describe_possible_c___future_features"></a><a class="link" href="boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_describe_possible_c___future_features" title="Macros that describe possible C++ future features">Macros
that describe possible C++ future features</a>
</h3></div></div></div>
<p>
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.
</p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Macro
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">BOOST_HAS_CONCEPTS</span></code>
</p>
</td>
<td>
<p>
The compiler supports concepts.
</p>
</td>
</tr></tbody>
</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_config.boost_macro_reference.macros_that_describe_c__11_features_not_supported"></a><a class="link" href="boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_describe_c__11_features_not_supported" title="Macros that describe C++11 features not supported">Macros <a name="boost_config.boost_macro_reference.macros_that_describe_c__11_features_not_supported"></a><a class="link" href="boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_describe_c__11_features_not_supported" title="Macros that describe C++11 features not supported">Macros
that describe C++11 features not supported</a> that describe C++11 features not supported</a>
</h3></div></div></div> </h3></div></div></div>
@@ -2650,6 +2608,19 @@
</td> </td>
</tr> </tr>
<tr> <tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">BOOST_NO_CXX11_ALIGNOF</span></code>
</p>
</td>
<td>
<p>
The compiler does not support the <code class="computeroutput"><span class="keyword">alignof</span></code>
keyword.
</p>
</td>
</tr>
<tr>
<td> <td>
<p> <p>
<code class="computeroutput"><span class="identifier">BOOST_NO_CXX11_ALLOCATOR</span></code> <code class="computeroutput"><span class="identifier">BOOST_NO_CXX11_ALLOCATOR</span></code>
@@ -2915,7 +2886,9 @@
</td> </td>
<td> <td>
<p> <p>
The standard library does not provide header &lt;codecvt&gt;. The standard library does not provide header &lt;codecvt&gt;. 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.
</p> </p>
</td> </td>
</tr> </tr>
@@ -3805,6 +3778,19 @@
</p> </p>
</td> </td>
</tr> </tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">BOOST_NULLPTR</span></code>
</p>
</td>
<td>
<p>
If <code class="computeroutput"><span class="identifier">BOOST_NO_CXX11_NULLPTR</span></code>
is not defined (i.e. C++11 compliant compilers), expands to <code class="computeroutput"><span class="keyword">nullptr</span></code>, otherwise expands to <code class="computeroutput"><span class="number">0</span></code>.
</p>
</td>
</tr>
</tbody> </tbody>
</table></div> </table></div>
</div> </div>
@@ -4222,6 +4208,19 @@
</p> </p>
</td> </td>
</tr> </tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">BOOST_NO_CXX17_DEDUCTION_GUIDES</span></code>
</p>
</td>
<td>
<p>
The compiler does not support class template argument deduction
(CTAD) guides.
</p>
</td>
</tr>
</tbody> </tbody>
</table></div> </table></div>
</div> </div>
@@ -4356,7 +4355,7 @@
</td> </td>
<td> <td>
<p> <p>
The compiler does not support the header <code class="computeroutput"><span class="special">&lt;</span><span class="identifier">format</span><span class="special">&gt;</span></code>. The compiler does not support the header <code class="computeroutput"><span class="special">&lt;</span><span class="identifier">source_location</span><span class="special">&gt;</span></code>.
</p> </p>
</td> </td>
</tr> </tr>
@@ -4452,7 +4451,7 @@
</td> </td>
<td> <td>
<p> <p>
The compiler does not support the header <code class="computeroutput"><span class="special">&lt;</span><span class="identifier">range</span><span class="special">&gt;</span></code>. The compiler does not support the header <code class="computeroutput"><span class="special">&lt;</span><span class="identifier">ranges</span><span class="special">&gt;</span></code>.
</p> </p>
</td> </td>
</tr> </tr>
@@ -4492,6 +4491,18 @@
</p> </p>
</td> </td>
</tr> </tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">BOOST_NO_CXX20_HDR_VERSION</span></code>
</p>
</td>
<td>
<p>
The compiler does not support the header <code class="computeroutput"><span class="special">&lt;</span><span class="identifier">version</span><span class="special">&gt;</span></code>.
</p>
</td>
</tr>
</tbody> </tbody>
</table></div> </table></div>
</div> </div>
@@ -4590,6 +4601,19 @@
</p> </p>
</td> </td>
</tr> </tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">BOOST_NO_CXX11_HDR_CODECVT</span></code>
</p>
</td>
<td>
<p>
The standard library no longer supports <code class="computeroutput"><span class="special">&lt;</span><span class="identifier">codecvt</span><span class="special">&gt;</span></code>,
there is as yet no replacement.
</p>
</td>
</tr>
</tbody> </tbody>
</table></div> </table></div>
</div> </div>
@@ -4824,8 +4848,8 @@
<span class="keyword">case</span> <span class="number">41</span><span class="special">:</span> <span class="keyword">case</span> <span class="number">41</span><span class="special">:</span>
<span class="keyword">if</span> <span class="special">(</span><span class="identifier">truth_is_out_there</span><span class="special">)</span> <span class="special">{</span> <span class="keyword">if</span> <span class="special">(</span><span class="identifier">truth_is_out_there</span><span class="special">)</span> <span class="special">{</span>
<span class="special">++</span><span class="identifier">x</span><span class="special">;</span> <span class="special">++</span><span class="identifier">x</span><span class="special">;</span>
<span class="identifier">BOOST_FALLTHROUGH</span><span class="special">;</span> <span class="comment">// Use instead of/along with annotations in </span> <span class="identifier">BOOST_FALLTHROUGH</span><span class="special">;</span> <span class="comment">// Use instead of/along with annotations in</span>
<span class="comment">// comments. </span> <span class="comment">// comments.</span>
<span class="special">}</span> <span class="keyword">else</span> <span class="special">{</span> <span class="special">}</span> <span class="keyword">else</span> <span class="special">{</span>
<span class="keyword">return</span> <span class="identifier">x</span><span class="special">;</span> <span class="keyword">return</span> <span class="identifier">x</span><span class="special">;</span>
<span class="special">}</span> <span class="special">}</span>
@@ -5017,14 +5041,13 @@
</td> </td>
<td> <td>
<p> <p>
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 <code class="computeroutput"><span class="identifier">restrict</span></code> of the C99 <code class="computeroutput"><span class="identifier">restrict</span></code>
keyword to notify the compiler that, for the lifetime of the qualified keyword to notify the compiler that, for the lifetime of the qualified
pointer variable, only it and its derivative value will be used pointer variable, only it and its derivative values will be used
to gain access to the object it references. This limits the effect to access the object it references. This limits the effect of pointer
of pointer aliasing and helps the optimizers in generating better aliasing and helps optimizers in generating better code. However,
code. However, i this condition is violated, undefined behavior if this condition is violated, undefined behavior may occur.
may occurs.
</p> </p>
<p> <p>
Usage example: Usage example:
@@ -5235,6 +5258,45 @@
</td> </td>
</tr> </tr>
<tr> <tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">BOOST_DEPRECATED</span><span class="special">(</span><span class="identifier">M</span><span class="special">)</span></code>
</p>
</td>
<td>
<p>
Expands to an attribute for a symbol that generates warnings when
that symbol is used in code. The warnings may contain a message
<code class="computeroutput"><span class="identifier">M</span></code>, 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.
</p>
<p>
Example:
</p>
<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">BOOST_DEPRECATED</span><span class="special">(</span><span class="string">"Use bar() instead."</span><span class="special">)</span>
<span class="keyword">void</span> <span class="identifier">foo</span><span class="special">();</span>
<span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">T</span> <span class="special">&gt;</span>
<span class="keyword">class</span> <span class="identifier">BOOST_DEPRECATED</span><span class="special">(</span><span class="string">"Use std::unique_ptr instead."</span><span class="special">)</span> <span class="identifier">auto_ptr</span>
<span class="special">{</span>
<span class="special">};</span>
<span class="identifier">BOOST_DEPRECATED</span><span class="special">(</span><span class="string">"Use std::numeric_limits&lt;int&gt;::max() instead."</span><span class="special">)</span>
<span class="keyword">const</span> <span class="keyword">int</span> <span class="identifier">max_int</span> <span class="special">=</span> <span class="number">0x7fffffff</span><span class="special">;</span>
</pre>
<p>
</p>
<p>
The warnings issued by <code class="computeroutput"><span class="identifier">BOOST_DEPRECATED</span></code>
can be suppressed by defining <code class="computeroutput"><span class="identifier">BOOST_ALLOW_DEPRECATED_SYMBOLS</span></code>
or <code class="computeroutput"><span class="identifier">BOOST_ALLOW_DEPRECATED</span></code>
macros.
</p>
</td>
</tr>
<tr>
<td> <td>
<p> <p>
<code class="computeroutput"><span class="identifier">BOOST_PRAGMA_MESSAGE</span><span class="special">(</span><span class="identifier">M</span><span class="special">)</span></code> <code class="computeroutput"><span class="identifier">BOOST_PRAGMA_MESSAGE</span><span class="special">(</span><span class="identifier">M</span><span class="special">)</span></code>
@@ -5278,7 +5340,9 @@
</p> </p>
<p> <p>
The messages issued by <code class="computeroutput"><span class="identifier">BOOST_HEADER_DEPRECATED</span></code> The messages issued by <code class="computeroutput"><span class="identifier">BOOST_HEADER_DEPRECATED</span></code>
can be suppressed by defining the macro <code class="computeroutput"><span class="identifier">BOOST_ALLOW_DEPRECATED_HEADERS</span></code>. can be suppressed by defining <code class="computeroutput"><span class="identifier">BOOST_ALLOW_DEPRECATED_HEADERS</span></code>
or <code class="computeroutput"><span class="identifier">BOOST_ALLOW_DEPRECATED</span></code>
macros.
</p> </p>
</td> </td>
</tr> </tr>
@@ -5476,6 +5540,29 @@
</td> </td>
</tr> </tr>
<tr> <tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">BOOST_CLANG_VERSION</span></code>
</p>
</td>
<td>
<p>
<code class="computeroutput"><span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
</p>
</td>
<td>
<p>
Defined to the version of the Clang compiler, usually <code class="computeroutput"><span class="identifier">__clang_major__</span> <span class="special">*</span>
<span class="number">10000</span> <span class="special">+</span>
<span class="identifier">__clang_minor__</span> <span class="special">*</span>
<span class="number">100</span> <span class="special">+</span>
<span class="identifier">__clang_patchlevel__</span></code>.
On Apple Clang, has a best-effort value reflecting the upstream
version, rather than the Apple version.
</p>
</td>
</tr>
<tr>
<td> <td>
<p> <p>
<code class="computeroutput"><span class="identifier">BOOST_BORLANDC</span></code> <code class="computeroutput"><span class="identifier">BOOST_BORLANDC</span></code>
@@ -5568,18 +5655,22 @@
<tr> <tr>
<td> <td>
<p> <p>
<code class="computeroutput"><span class="identifier">BOOST_NO_WREGEX</span></code> <code class="computeroutput"><span class="identifier">BOOST_MSSTL_VERSION</span></code>
</p> </p>
</td> </td>
<td> <td>
<p> <p>
<code class="computeroutput"><span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">regex</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code> <code class="computeroutput"><span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">config</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
</p> </p>
</td> </td>
<td> <td>
<p> <p>
Defined if the regex library does not support wide character regular Defined if the Microsoft Visual C++ standard library is in use.
expressions. Has the value of <code class="computeroutput"><span class="identifier">_MSVC_STL_VERSION</span></code>
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.
</p> </p>
</td> </td>
</tr> </tr>
@@ -6859,6 +6950,26 @@
</p> </p>
</td> </td>
</tr> </tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">BOOST_DISABLE_EXPLICIT_SYMBOL_VISIBILITY</span></code>
</p>
</td>
<td>
<p>
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.
</p>
</td>
</tr>
</tbody> </tbody>
</table></div> </table></div>
<p> <p>

6
doc/html/index.html
View File

@@ -58,12 +58,12 @@
</dl></dd> </dl></dd>
<dt><span class="section"><a href="boost_config/boost_macro_reference.html">Boost Macro Reference</a></span></dt> <dt><span class="section"><a href="boost_config/boost_macro_reference.html">Boost Macro Reference</a></span></dt>
<dd><dl> <dd><dl>
<dt><span class="section"><a href="boost_config/boost_macro_reference.html#boost_config.boost_macro_reference.broad_c___standard_level_checks">Broad
C++ Standard Level Checks</a></span></dt>
<dt><span class="section"><a href="boost_config/boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_describe_c__03_defects">Macros <dt><span class="section"><a href="boost_config/boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_describe_c__03_defects">Macros
that describe C++03 defects</a></span></dt> that describe C++03 defects</a></span></dt>
<dt><span class="section"><a href="boost_config/boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_describe_optional_features">Macros <dt><span class="section"><a href="boost_config/boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_describe_optional_features">Macros
that describe optional features</a></span></dt> that describe optional features</a></span></dt>
<dt><span class="section"><a href="boost_config/boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_describe_possible_c___future_features">Macros
that describe possible C++ future features</a></span></dt>
<dt><span class="section"><a href="boost_config/boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_describe_c__11_features_not_supported">Macros <dt><span class="section"><a href="boost_config/boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_describe_c__11_features_not_supported">Macros
that describe C++11 features not supported</a></span></dt> that describe C++11 features not supported</a></span></dt>
<dt><span class="section"><a href="boost_config/boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_allow_use_of_c__11_features_with_c__03_compilers">Macros <dt><span class="section"><a href="boost_config/boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_allow_use_of_c__11_features_with_c__03_compilers">Macros
@@ -992,7 +992,7 @@
</div> </div>
</div> </div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"><p><small>Last revised: March 05, 2021 at 17:51:35 GMT</small></p></td> <td align="left"><p><small>Last revised: February 22, 2023 at 19:02:21 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td> <td align="right"><div class="copyright-footer"></div></td>
</tr></table> </tr></table>
<hr> <hr>

16
doc/macro_reference.qbk
View File

@@ -630,22 +630,6 @@ standard).
[endsect] [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] [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, The following macros describe features in the 2011 ISO C++ standard, formerly known as C++0x,