Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r86740 - in website/public_html/live/doc/fixes/boost_1_55_0: . libs libs/utility libs/utility/doc libs/utility/doc/html
From: dnljms_at_[hidden]
Date: 2013-11-17 12:17:50


Author: danieljames
Date: 2013-11-17 12:17:50 EST (Sun, 17 Nov 2013)
New Revision: 86740
URL: http://svn.boost.org/trac/boost/changeset/86740

Log:
Add missing utility documentation.

Added:
   website/public_html/live/doc/fixes/boost_1_55_0/
   website/public_html/live/doc/fixes/boost_1_55_0/libs/
   website/public_html/live/doc/fixes/boost_1_55_0/libs/utility/
   website/public_html/live/doc/fixes/boost_1_55_0/libs/utility/doc/
   website/public_html/live/doc/fixes/boost_1_55_0/libs/utility/doc/html/
   website/public_html/live/doc/fixes/boost_1_55_0/libs/utility/doc/html/explicit_operator_bool.html (contents, props changed)
   website/public_html/live/doc/fixes/boost_1_55_0/libs/utility/index.html (contents, props changed)

Added: website/public_html/live/doc/fixes/boost_1_55_0/libs/utility/doc/html/explicit_operator_bool.html
==============================================================================
--- /dev/null 00:00:00 1970 (empty, because file is newly added)
+++ website/public_html/live/doc/fixes/boost_1_55_0/libs/utility/doc/html/explicit_operator_bool.html 2013-11-17 12:17:50 EST (Sun, 17 Nov 2013) (r86740)
@@ -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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</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 http://www.boost.org/LICENSE_1_0.txt)
+ </p>
+</div></div>
+</div>
+<hr>
+</div>
+<div class="toc">
+<p><b>Table of Contents</b></p>
+<dl class="toc">
+<dt><span class="section">Overview</span></dt>
+<dt><span class="section">Examples</span></dt>
+<dt><span class="section">History</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>

Added: website/public_html/live/doc/fixes/boost_1_55_0/libs/utility/index.html
==============================================================================
--- /dev/null 00:00:00 1970 (empty, because file is newly added)
+++ website/public_html/live/doc/fixes/boost_1_55_0/libs/utility/index.html 2013-11-17 12:17:50 EST (Sun, 17 Nov 2013) (r86740)
@@ -0,0 +1,52 @@
+<html>
+ <head>
+ <meta http-equiv="Content-Language" content="en-us">
+ <meta name="GENERATOR" content="Microsoft FrontPage 5.0">
+ <meta name="ProgId" content="FrontPage.Editor.Document">
+ <meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
+ <title>Boost Utility Library</title>
+ </head>
+ <body bgcolor="#FFFFFF">
+ <h1><IMG SRC="../../boost.png" WIDTH="276" HEIGHT="86" align="center">Boost
+ Utility Library</h1>
+ <p>The Boost Utility Library isn't really a single library at all. It is just a
+ collection for components too small to be called libraries in their own right.</p>
+ <p>But that doesn't mean there isn't useful stuff here. Take a look:</p>
+ <blockquote>
+ <p>
+ addressof<br>
+ assert<br>
+ base_from_member<br>
+ BOOST_BINARY<br>
+ call_traits<br>
+ checked_delete<br>
+ compressed_pair<br>
+ current_function<br>
+ declval<br>
+ enable_if<br>
+ in_place_factory<br>
+ iterator_adaptors<br>
+ generator iterator adaptors<br>
+ next/prior<br>
+ noncopyable<br>
+ operators<br>
+ result_of<br>
+ swap<br>
+ throw_exception<br>
+ utility<br>
+ string_ref<br>
+ value_init<br>
+ BOOST_EXPLICIT_OPERATOR_BOOL and BOOST_CONSTEXPR_EXPLICIT_OPERATOR_BOOL
+ </p>
+ </blockquote>
+ <hr>
+ <p>&copy; Copyright Beman Dawes, 2001</p>
+ <p>Distributed under the Boost Software License, Version 1.0. (See
+ accompanying file <a href="../../LICENSE_1_0.txt">
+ LICENSE_1_0.txt</a> or copy at
+ <a href="http://www.boost.org/LICENSE_1_0.txt">
+ www.boost.org/LICENSE_1_0.txt</a>)</p>
+ <p>Revised
+ <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->07 November, 2006<!--webbot bot="Timestamp" endspan i-checksum="39368" --></p>
+ </body>
+</html>


Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk