Merge utility documentation.

- Fixed duplicate anchors. - Add BOOST_EXPLICIT_OPERATOR_BOOL documentation. - Rebuild some of the utility documentation. [SVN r86797]
2025-05-09 15:04:00 +00:00 · 2013-11-23 14:23:45 +00:00 · 2013-11-23 14:23:45 +00:00 · 96da5105ab
commit 96da5105ab
parent 44a98b121b
5 changed files with 147 additions and 30 deletions
--- a/doc/html/declval.html
+++ b/doc/html/declval.html
@ -3,7 +3,7 @@
 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 <title>Declval</title>
 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.76.0">
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="declval.html" title="Declval">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@ -31,9 +31,10 @@
 </h3></div>
 </div></div>
 <div><p class="copyright">Copyright &#169; 2008 Howard Hinnant</p></div>
-<div><p class="copyright">Copyright &#169; 2009 -2012 Vicente J. Botet Escriba</p></div>
+<div><p class="copyright">Copyright &#169; 2009-2012 Vicente
+      J. Botet Escriba</p></div>
 <div><div class="legalnotice">
-<a name="idp13449552"></a><p>
+<a name="declval.legal"></a><p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
@ -43,7 +44,7 @@
 </div>
 <div class="toc">
 <p><b>Table of Contents</b></p>
-<dl>
+<dl class="toc">
 <dt><span class="section"><a href="declval.html#declval.overview">Overview</a></span></dt>
 <dt><span class="section"><a href="declval.html#declval.reference">Reference </a></span></dt>
 <dt><span class="section"><a href="declval.html#declval.history">History</a></span></dt>
@ -66,13 +67,13 @@
      in a non-using context, e.g. given the declaration
    </p>
 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
-<span class="identifier">T</span><span class="special">&amp;&amp;</span> <span class="identifier">declval</span><span class="special">();</span> <span class="comment">// not used
-</span></pre>
+<span class="identifier">T</span><span class="special">&amp;&amp;</span> <span class="identifier">declval</span><span class="special">();</span> <span class="comment">// not used</span>
+</pre>
 <p>
      as part of the function template declaration
    </p>
 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">To</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">From</span><span class="special">&gt;</span>
-<span class="identifier">decltype</span><span class="special">(</span><span class="keyword">static_cast</span><span class="special">&lt;</span><span class="identifier">To</span><span class="special">&gt;(</span><span class="identifier">declval</span><span class="special">&lt;</span><span class="identifier">From</span><span class="special">&gt;()))</span> <span class="identifier">convert</span><span class="special">(</span><span class="identifier">From</span><span class="special">&amp;&amp;);</span>
+<span class="keyword">decltype</span><span class="special">(</span><span class="keyword">static_cast</span><span class="special">&lt;</span><span class="identifier">To</span><span class="special">&gt;(</span><span class="identifier">declval</span><span class="special">&lt;</span><span class="identifier">From</span><span class="special">&gt;()))</span> <span class="identifier">convert</span><span class="special">(</span><span class="identifier">From</span><span class="special">&amp;&amp;);</span>
 </pre>
 <p>
      or as part of a class template definition
@ -82,7 +83,7 @@
 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">Fn</span><span class="special">,</span> <span class="keyword">class</span><span class="special">...</span> <span class="identifier">ArgTypes</span><span class="special">&gt;</span>
 <span class="keyword">struct</span> <span class="identifier">result_of</span><span class="special">&lt;</span><span class="identifier">Fn</span><span class="special">(</span><span class="identifier">ArgTypes</span><span class="special">...)&gt;</span>
 <span class="special">{</span>
-  <span class="keyword">typedef</span> <span class="identifier">decltype</span><span class="special">(</span><span class="identifier">declval</span><span class="special">&lt;</span><span class="identifier">Fn</span><span class="special">&gt;()(</span><span class="identifier">declval</span><span class="special">&lt;</span><span class="identifier">ArgTypes</span><span class="special">&gt;()...))</span> <span class="identifier">type</span><span class="special">;</span>
+  <span class="keyword">typedef</span> <span class="keyword">decltype</span><span class="special">(</span><span class="identifier">declval</span><span class="special">&lt;</span><span class="identifier">Fn</span><span class="special">&gt;()(</span><span class="identifier">declval</span><span class="special">&lt;</span><span class="identifier">ArgTypes</span><span class="special">&gt;()...))</span> <span class="identifier">type</span><span class="special">;</span>
 <span class="special">};</span>
 </pre>
 <p>
@ -94,8 +95,8 @@
      to
    </p>
 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
-<span class="keyword">typename</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">add_rvalue_reference</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">declval</span><span class="special">();</span> <span class="comment">// not used
-</span></pre>
+<span class="keyword">typename</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">add_rvalue_reference</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">declval</span><span class="special">();</span> <span class="comment">// not used</span>
+</pre>
 <p>
      which ensures that we can also use cv void as template parameter. The careful
      reader might have noticed that <code class="computeroutput"><span class="identifier">declval</span><span class="special">()</span></code> already exists under the name create() as
@ -119,10 +120,10 @@
 <pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</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">typename</span> <span class="identifier">add_rvalue_reference</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">declval</span><span class="special">()</span> <span class="identifier">noexcept</span><span class="special">;</span> <span class="comment">// as unevaluated operand
-</span>
-<span class="special">}</span>  <span class="comment">// namespace boost
-</span></pre>
+    <span class="keyword">typename</span> <span class="identifier">add_rvalue_reference</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">declval</span><span class="special">()</span> <span class="keyword">noexcept</span><span class="special">;</span> <span class="comment">// as unevaluated operand</span>
+
+<span class="special">}</span>  <span class="comment">// namespace boost</span>
+</pre>
 <p>
      The library provides the function template declval to simplify the definition
      of expressions which occur as unevaluated operands.
@ -142,7 +143,7 @@
      <span class="bold"><strong>Example:</strong></span>
    </p>
 <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">To</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">From</span><span class="special">&gt;</span>
-<span class="identifier">decltype</span><span class="special">(</span><span class="keyword">static_cast</span><span class="special">&lt;</span><span class="identifier">To</span><span class="special">&gt;(</span><span class="identifier">declval</span><span class="special">&lt;</span><span class="identifier">From</span><span class="special">&gt;()))</span> <span class="identifier">convert</span><span class="special">(</span><span class="identifier">From</span><span class="special">&amp;&amp;);</span>
+<span class="keyword">decltype</span><span class="special">(</span><span class="keyword">static_cast</span><span class="special">&lt;</span><span class="identifier">To</span><span class="special">&gt;(</span><span class="identifier">declval</span><span class="special">&lt;</span><span class="identifier">From</span><span class="special">&gt;()))</span> <span class="identifier">convert</span><span class="special">(</span><span class="identifier">From</span><span class="special">&amp;&amp;);</span>
 </pre>
 <p>
      Declares a function template convert which only participates in overloading
@ -153,21 +154,22 @@
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="declval.history"></a><a class="link" href="declval.html#declval.history" title="History">History</a>
 </h2></div></div></div>
-<a name="declval.history.boost_1_50"></a><h4>
-<a name="idp13553216"></a>
-      <a class="link" href="declval.html#declval.history.boost_1_50">boost 1.50</a>
+<h4>
+<a name="declval.history.h0"></a>
+      <span class="phrase"><a name="declval.history.boost_1_50"></a></span><a class="link" href="declval.html#declval.history.boost_1_50">boost
+      1.50</a>
    </h4>
 <p>
      Fixes:
    </p>
-<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
          <a href="http://svn.boost.org/trac/boost/ticket/6570" target="_top">#6570</a>
          Adding noexcept to boost::declval.
        </li></ul></div>
 </div>
 </div>
 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: May 28, 2012 at 18:59:06 GMT</small></p></td>
+<td align="left"><p><small>Last revised: November 23, 2013 at 14:11:12 GMT</small></p></td>
 <td align="right"><div class="copyright-footer"></div></td>
 </tr></table>
 <hr>
--- a/doc/html/explicit_operator_bool.html
+++ b/doc/html/explicit_operator_bool.html
@ -0,0 +1,115 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>BOOST_EXPLICIT_OPERATOR_BOOL and BOOST_CONSTEXPR_EXPLICIT_OPERATOR_BOOL</title>
+<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<link rel="home" href="explicit_operator_bool.html" title="BOOST_EXPLICIT_OPERATOR_BOOL and BOOST_CONSTEXPR_EXPLICIT_OPERATOR_BOOL">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
+<td align="center"><a href="../../../../index.html">Home</a></td>
+<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
+<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
+<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
+<td align="center"><a href="../../../../more/index.htm">More</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav"></div>
+<div class="article">
+<div class="titlepage">
+<div>
+<div><h2 class="title">
+<a name="boost_explicit_operator_bool_and_boost_constexpr_explicit_operator_bool"></a>BOOST_EXPLICIT_OPERATOR_BOOL and BOOST_CONSTEXPR_EXPLICIT_OPERATOR_BOOL</h2></div>
+<div><div class="authorgroup"><div class="author"><h3 class="author">
+<span class="firstname">Andrey</span> <span class="surname">Semashev</span>
+</h3></div></div></div>
+<div><p class="copyright">Copyright &#169; 2013 Andrey Semashev</p></div>
+<div><div class="legalnotice">
+<a name="boost_explicit_operator_bool_and_boost_constexpr_explicit_operator_bool.legal"></a><p>
+        Distributed under the Boost Software License, Version 1.0. (See accompanying
+        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
+      </p>
+</div></div>
+</div>
+<hr>
+</div>
+<div class="toc">
+<p><b>Table of Contents</b></p>
+<dl class="toc">
+<dt><span class="section"><a href="explicit_operator_bool.html#boost_explicit_operator_bool_and_boost_constexpr_explicit_operator_bool.overview">Overview</a></span></dt>
+<dt><span class="section"><a href="explicit_operator_bool.html#boost_explicit_operator_bool_and_boost_constexpr_explicit_operator_bool.examples">Examples</a></span></dt>
+<dt><span class="section"><a href="explicit_operator_bool.html#boost_explicit_operator_bool_and_boost_constexpr_explicit_operator_bool.history">History</a></span></dt>
+</dl>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_explicit_operator_bool_and_boost_constexpr_explicit_operator_bool.overview"></a><a class="link" href="explicit_operator_bool.html#boost_explicit_operator_bool_and_boost_constexpr_explicit_operator_bool.overview" title="Overview">Overview</a>
+</h2></div></div></div>
+<p>
+      <code class="computeroutput"><span class="identifier">BOOST_EXPLICIT_OPERATOR_BOOL</span><span class="special">()</span></code> and <code class="computeroutput"><span class="identifier">BOOST_CONSTEXPR_EXPLICIT_OPERATOR_BOOL</span><span class="special">()</span></code> are compatibility helper macros that expand
+      to an explicit conversion operator to <code class="computeroutput"><span class="keyword">bool</span></code>.
+      For compilers not supporting explicit conversion operators introduced in C++11
+      the macros expand to a conversion operator that implements the <a href="http://en.wikibooks.org/wiki/More_C%2B%2B_Idioms/Safe_bool" target="_top">safe
+      bool idiom</a>. In case if the compiler is not able to handle safe bool
+      idiom well the macros expand to a regular conversion operator to <code class="computeroutput"><span class="keyword">bool</span></code>.
+    </p>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_explicit_operator_bool_and_boost_constexpr_explicit_operator_bool.examples"></a><a class="link" href="explicit_operator_bool.html#boost_explicit_operator_bool_and_boost_constexpr_explicit_operator_bool.examples" title="Examples">Examples</a>
+</h2></div></div></div>
+<p>
+      Both macros are intended to be placed within a user's class definition. The
+      generated conversion operators will be implemented in terms of <code class="computeroutput"><span class="keyword">operator</span><span class="special">!()</span></code>
+      that should be defined by user in this class. In case of <code class="computeroutput"><span class="identifier">BOOST_CONSTEXPR_EXPLICIT_OPERATOR_BOOL</span><span class="special">()</span></code> the generated conversion operator will be
+      declared <code class="computeroutput"><span class="keyword">constexpr</span></code> which requires
+      the corresponding <code class="computeroutput"><span class="keyword">operator</span><span class="special">!()</span></code>
+      to also be <code class="computeroutput"><span class="keyword">constexpr</span></code>.
+    </p>
+<pre class="programlisting"><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">my_ptr</span>
+<span class="special">{</span>
+    <span class="identifier">T</span><span class="special">*</span> <span class="identifier">m_p</span><span class="special">;</span>
+
+<span class="keyword">public</span><span class="special">:</span>
+    <span class="identifier">BOOST_EXPLICIT_OPERATOR_BOOL</span><span class="special">()</span>
+
+    <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!()</span> <span class="keyword">const</span>
+    <span class="special">{</span>
+        <span class="keyword">return</span> <span class="special">!</span><span class="identifier">m_p</span><span class="special">;</span>
+    <span class="special">}</span>
+<span class="special">};</span>
+</pre>
+<p>
+      Now <code class="computeroutput"><span class="identifier">my_ptr</span></code> can be used in conditional
+      expressions, similarly to a regular pointer:
+    </p>
+<pre class="programlisting"><span class="identifier">my_ptr</span><span class="special">&lt;</span> <span class="keyword">int</span> <span class="special">&gt;</span> <span class="identifier">p</span><span class="special">;</span>
+<span class="keyword">if</span> <span class="special">(</span><span class="identifier">p</span><span class="special">)</span>
+    <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"true"</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_explicit_operator_bool_and_boost_constexpr_explicit_operator_bool.history"></a><a class="link" href="explicit_operator_bool.html#boost_explicit_operator_bool_and_boost_constexpr_explicit_operator_bool.history" title="History">History</a>
+</h2></div></div></div>
+<h4>
+<a name="boost_explicit_operator_bool_and_boost_constexpr_explicit_operator_bool.history.h0"></a>
+      <span class="phrase"><a name="boost_explicit_operator_bool_and_boost_constexpr_explicit_operator_bool.history.boost_1_55"></a></span><a class="link" href="explicit_operator_bool.html#boost_explicit_operator_bool_and_boost_constexpr_explicit_operator_bool.history.boost_1_55">boost
+      1.55</a>
+    </h4>
+<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
+          The macro was extracted from Boost.Log.
+        </li></ul></div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"><p><small>Last revised: November 17, 2013 at 17:08:52 GMT</small></p></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav"></div>
+</body>
+</html>
--- a/doc/html/string_ref.html
+++ b/doc/html/string_ref.html
@ -3,7 +3,7 @@
 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 <title>String_Ref</title>
 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="string_ref.html" title="String_Ref">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@ -37,7 +37,7 @@
 </div>
 <div class="toc">
 <p><b>Table of Contents</b></p>
-<dl>
+<dl class="toc">
 <dt><span class="section"><a href="string_ref.html#string_ref.overview">Overview</a></span></dt>
 <dt><span class="section"><a href="string_ref.html#string_ref.examples">Examples</a></span></dt>
 <dt><span class="section"><a href="string_ref.html#string_ref.reference">Reference </a></span></dt>
@ -262,16 +262,16 @@
 </h2></div></div></div>
 <h4>
 <a name="string_ref.history.h0"></a>
-      <span><a name="string_ref.history.boost_1_53"></a></span><a class="link" href="string_ref.html#string_ref.history.boost_1_53">boost
+      <span class="phrase"><a name="string_ref.history.boost_1_53"></a></span><a class="link" href="string_ref.html#string_ref.history.boost_1_53">boost
      1.53</a>
    </h4>
-<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
          Introduced
        </li></ul></div>
 </div>
 </div>
 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: October 27, 2013 at 21:01:34 GMT</small></p></td>
+<td align="left"><p><small>Last revised: November 23, 2013 at 14:12:56 GMT</small></p></td>
 <td align="right"><div class="copyright-footer"></div></td>
 </tr></table>
 <hr>
--- a/enable_if.html
+++ b/enable_if.html
@ -201,7 +201,7 @@ extra template parameter.
 <!--TOC subsection Enabling function templates in C++0x-->

 <A NAME="sec:enable_if_0x"></A>
-<H3><A NAME="htoc7">3.1</A>&nbsp;&nbsp;Enabling function templates in C++0x</H3><!--SEC END -->
+<H3><A NAME="htoc6">3.1</A>&nbsp;&nbsp;Enabling function templates in C++0x</H3><!--SEC END -->

 In a compiler which supports C++0x default arguments for function template parameters, you can
 enable and disable function templates by adding an additional template parameter. This approach
@ -416,7 +416,7 @@ subscript operators).
 </UL>
 <!--TOC section Acknowledgements-->

-<H2><A NAME="htoc10">4</A>&nbsp;&nbsp;Acknowledgements</H2><!--SEC END -->
+<H2><A NAME="htoc11">4</A>&nbsp;&nbsp;Acknowledgements</H2><!--SEC END -->

 We are grateful to Howard Hinnant, Jason Shirk, Paul Mensonides, and Richard
 Smith whose findings have influenced the library.<BR>
--- a/index.html
+++ b/index.html
@ -35,8 +35,8 @@
 				<a href="throw_exception.html">throw_exception</a><br>
 				<a href="utility.htm">utility</a><br>
            <a href="doc/html/string_ref.html">string_ref</a><br>
-            <a href="value_init.htm">value_init</a>
-            <a href="doc/html/explicit_operator_bool.html">BOOST_EXPLICIT_OPERATOR_BOOL and BOOST_CONSTEXPR_EXPLICIT_OPERATOR_BOOL</a><br>
+            <a href="value_init.htm">value_init</a><br>
+            <a href="doc/html/explicit_operator_bool.html">BOOST_EXPLICIT_OPERATOR_BOOL and BOOST_CONSTEXPR_EXPLICIT_OPERATOR_BOOL</a>
         </p>
 		</blockquote>
 		<hr>