|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r74336 - in trunk/libs/type_traits/doc: . html html/boost_typetraits/reference html/index
From: john_at_[hidden]
Date: 2011-09-10 12:58:01
Author: johnmaddock
Date: 2011-09-10 12:58:00 EDT (Sat, 10 Sep 2011)
New Revision: 74336
URL: http://svn.boost.org/trac/boost/changeset/74336
Log:
Fix errors in is_union examples.
Fixes #5885.
Text files modified:
trunk/libs/type_traits/doc/html/boost_typetraits/reference/is_union.html | 12 ++++++++----
trunk/libs/type_traits/doc/html/index.html | 2 +-
trunk/libs/type_traits/doc/html/index/s11.html | 2 +-
trunk/libs/type_traits/doc/html/index/s12.html | 2 +-
trunk/libs/type_traits/doc/html/index/s13.html | 2 +-
trunk/libs/type_traits/doc/html/index/s14.html | 2 +-
trunk/libs/type_traits/doc/is_union.qbk | 10 ++++++----
7 files changed, 19 insertions(+), 13 deletions(-)
Modified: trunk/libs/type_traits/doc/html/boost_typetraits/reference/is_union.html
==============================================================================
--- trunk/libs/type_traits/doc/html/boost_typetraits/reference/is_union.html (original)
+++ trunk/libs/type_traits/doc/html/boost_typetraits/reference/is_union.html 2011-09-10 12:58:00 EDT (Sat, 10 Sep 2011)
@@ -62,20 +62,24 @@
<p>
<span class="bold"><strong>Examples:</strong></span>
</p>
+<p>
+ Given <code class="computeroutput"><span class="keyword">union</span> <span class="identifier">my_union</span>
+ <span class="special">{};</span></code> then:
+ </p>
<div class="blockquote"><blockquote class="blockquote"><p>
- <code class="computeroutput"><span class="identifier">is_union</span><span class="special"><</span><span class="keyword">void</span><span class="special">></span></code>
+ <code class="computeroutput"><span class="identifier">is_union</span><span class="special"><</span><span class="identifier">my_union</span><span class="special">></span></code>
inherits from <code class="computeroutput"><a class="link" href="integral_constant.html" title="integral_constant">true_type</a></code>.
</p></blockquote></div>
<div class="blockquote"><blockquote class="blockquote"><p>
- <code class="computeroutput"><span class="identifier">is_union</span><span class="special"><</span><span class="keyword">const</span> <span class="keyword">void</span><span class="special">>::</span><span class="identifier">type</span></code>
+ <code class="computeroutput"><span class="identifier">is_union</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">my_union</span><span class="special">>::</span><span class="identifier">type</span></code>
is the type <code class="computeroutput"><a class="link" href="integral_constant.html" title="integral_constant">true_type</a></code>.
</p></blockquote></div>
<div class="blockquote"><blockquote class="blockquote"><p>
- <code class="computeroutput"><span class="identifier">is_union</span><span class="special"><</span><span class="keyword">void</span><span class="special">>::</span><span class="identifier">value</span></code> is an integral constant expression
+ <code class="computeroutput"><span class="identifier">is_union</span><span class="special"><</span><span class="identifier">my_union</span><span class="special">>::</span><span class="identifier">value</span></code> is an integral constant expression
that evaluates to <span class="emphasis"><em>true</em></span>.
</p></blockquote></div>
<div class="blockquote"><blockquote class="blockquote"><p>
- <code class="computeroutput"><span class="identifier">is_union</span><span class="special"><</span><span class="keyword">void</span><span class="special">*>::</span><span class="identifier">value</span></code> is an integral constant expression
+ <code class="computeroutput"><span class="identifier">is_union</span><span class="special"><</span><span class="identifier">my_union</span><span class="special">*>::</span><span class="identifier">value</span></code> is an integral constant expression
that evaluates to <span class="emphasis"><em>false</em></span>.
</p></blockquote></div>
<div class="blockquote"><blockquote class="blockquote"><p>
Modified: trunk/libs/type_traits/doc/html/index.html
==============================================================================
--- trunk/libs/type_traits/doc/html/index.html (original)
+++ trunk/libs/type_traits/doc/html/index.html 2011-09-10 12:58:00 EDT (Sat, 10 Sep 2011)
@@ -30,7 +30,7 @@
Marcus, Itay Maman, John Maddock, Alexander Nasonov, Thorsten Ottosen, Robert
Ramey and Jeremy Siek</p></div>
<div><div class="legalnotice">
-<a name="id893499"></a><p>
+<a name="id880058"></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>
Modified: trunk/libs/type_traits/doc/html/index/s11.html
==============================================================================
--- trunk/libs/type_traits/doc/html/index/s11.html (original)
+++ trunk/libs/type_traits/doc/html/index/s11.html 2011-09-10 12:58:00 EDT (Sat, 10 Sep 2011)
@@ -24,7 +24,7 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id967562"></a>Class Index</h2></div></div></div>
+<a name="id952889"></a>Class Index</h2></div></div></div>
<p><a class="link" href="s11.html#idx_id_0">A</a> <a class="link" href="s11.html#idx_id_2">C</a> <a class="link" href="s11.html#idx_id_3">D</a> <a class="link" href="s11.html#idx_id_4">E</a> <a class="link" href="s11.html#idx_id_5">F</a> <a class="link" href="s11.html#idx_id_6">H</a> <a class="link" href="s11.html#idx_id_7">I</a> <a class="link" href="s11.html#idx_id_8">M</a> <a class="link" href="s11.html#idx_id_9">P</a> <a class="link" href="s11.html#idx_id_10">R</a> <a class="link" href="s11.html#idx_id_11">T</a></p>
<div class="variablelist"><dl>
<dt>
Modified: trunk/libs/type_traits/doc/html/index/s12.html
==============================================================================
--- trunk/libs/type_traits/doc/html/index/s12.html (original)
+++ trunk/libs/type_traits/doc/html/index/s12.html 2011-09-10 12:58:00 EDT (Sat, 10 Sep 2011)
@@ -24,7 +24,7 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id968602"></a>Typedef Index</h2></div></div></div>
+<a name="id953930"></a>Typedef Index</h2></div></div></div>
<p><a class="link" href="s12.html#idx_id_18">F</a> <a class="link" href="s12.html#idx_id_23">R</a> <a class="link" href="s12.html#idx_id_24">T</a></p>
<div class="variablelist"><dl>
<dt>
Modified: trunk/libs/type_traits/doc/html/index/s13.html
==============================================================================
--- trunk/libs/type_traits/doc/html/index/s13.html (original)
+++ trunk/libs/type_traits/doc/html/index/s13.html 2011-09-10 12:58:00 EDT (Sat, 10 Sep 2011)
@@ -24,7 +24,7 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id968712"></a>Macro Index</h2></div></div></div>
+<a name="id954040"></a>Macro Index</h2></div></div></div>
<p><a class="link" href="s13.html#idx_id_27">B</a></p>
<div class="variablelist"><dl>
<dt>
Modified: trunk/libs/type_traits/doc/html/index/s14.html
==============================================================================
--- trunk/libs/type_traits/doc/html/index/s14.html (original)
+++ trunk/libs/type_traits/doc/html/index/s14.html 2011-09-10 12:58:00 EDT (Sat, 10 Sep 2011)
@@ -23,7 +23,7 @@
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id969254"></a>Index</h2></div></div></div>
+<a name="id954581"></a>Index</h2></div></div></div>
<p><a class="link" href="s14.html#idx_id_39">A</a> <a class="link" href="s14.html#idx_id_40">B</a> <a class="link" href="s14.html#idx_id_41">C</a> <a class="link" href="s14.html#idx_id_42">D</a> <a class="link" href="s14.html#idx_id_43">E</a> <a class="link" href="s14.html#idx_id_44">F</a> <a class="link" href="s14.html#idx_id_45">H</a> <a class="link" href="s14.html#idx_id_46">I</a> <a class="link" href="s14.html#idx_id_47">M</a> <a class="link" href="s14.html#idx_id_48">P</a> <a class="link" href="s14.html#idx_id_49">R</a> <a class="link" href="s14.html#idx_id_50">T</a> <a class="link" href="s14.html#idx_id_51">U</a></p>
<div class="variablelist"><dl>
<dt>
Modified: trunk/libs/type_traits/doc/is_union.qbk
==============================================================================
--- trunk/libs/type_traits/doc/is_union.qbk (original)
+++ trunk/libs/type_traits/doc/is_union.qbk 2011-09-10 12:58:00 EDT (Sat, 10 Sep 2011)
@@ -30,14 +30,16 @@
__examples
-[:`is_union<void>` inherits from `__true_type`.]
+Given `union my_union {};` then:
-[:`is_union<const void>::type` is the type `__true_type`.]
+[:`is_union<my_union>` inherits from `__true_type`.]
-[:`is_union<void>::value` is an integral constant
+[:`is_union<const my_union>::type` is the type `__true_type`.]
+
+[:`is_union<my_union>::value` is an integral constant
expression that evaluates to /true/.]
-[:`is_union<void*>::value` is an integral constant
+[:`is_union<my_union*>::value` is an integral constant
expression that evaluates to /false/.]
[:`is_union<T>::value_type` is the type `bool`.]
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