boost_mirror/variant
1
0
Fork 0
mirror of https://github.com/boostorg/variant.git synced 2025-05-12 13:51:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added macro to docs

Browse Source
This commit is contained in:
Nikita Kniazev 2019-02-24 03:42:11 +03:00
parent df4e29cf1e
commit 11d03f3b51
2 changed files with 31 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/reference/recursive_wrapper.xml
View File

@ -212,6 +212,8 @@
<description>
<simpara>Returns <code>true</code> when <code>*this</code>
contains a value.</simpara>
<simpara>Note: When <macroname>BOOST_VARIANT_NO_RECURSIVE_WRAPPER_POINTER_STEALING</macroname>
compatibility macro is defined &ndash; always returns <code>false</code>.</simpara>
</description>
<throws>Will not throw.</throws>
@ -309,4 +311,21 @@
</class>
</namespace>
<macro name="BOOST_VARIANT_NO_RECURSIVE_WRAPPER_POINTER_STEALING">
<purpose>
<simpara>A backward-compatibility/migration macro for reverting to the
previous never-empty <code><classname>recursive_wrapper</classname></code>.</simpara>
</purpose>
<description>
<para>
Defining the macro disables <code><classname>recursive_wrapper</classname></code> pointer
stealing from an other <code><classname>recursive_wrapper</classname></code> on move
construction.
</para>
<para>
Not defined by default. Appeared in Boost 1.70.
</para>
</description>
</macro>
</header>

8
doc/reference/variant.xml
View File

@ -508,14 +508,18 @@
<method name="empty" cv="const">
<type>bool</type>
<returns><itemizedlist>
<returns>
<itemizedlist>
<listitem><code>false</code>: when is not a recursive <code>variant
</code> &ndash; it always contains exactly one of its bounded types.
(See <xref linkend="variant.design.never-empty"/> for more
information.)</listitem>
<listitem><code>true</code>: when a recursive <code>variant</code>
value was moved out.</listitem>
</itemizedlist></returns>
</itemizedlist>
<simpara>Note: When <macroname>BOOST_VARIANT_NO_RECURSIVE_WRAPPER_POINTER_STEALING</macroname>
compatibility macro is defined &ndash; always returns <code>false</code>.</simpara>
</returns>
<rationale>
<simpara>Facilitates generic compatibility with