Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r63426 - trunk/libs/system/doc
From: bdawes_at_[hidden]
Date: 2010-06-29 08:33:28

Next message: bbartmanboost_at_[hidden]: "[Boost-commit] svn:boost r63427 - in sandbox/SOC/2010/bit_masks: boost/integer/details/bft lib/integer/test/bft_testing"
Previous message: david.bellot_at_[hidden]: "[Boost-commit] svn:boost r63425 - branches/ublas-doxygen"

Author: bemandawes
Date: 2010-06-29 08:33:26 EDT (Tue, 29 Jun 2010)
New Revision: 63426
URL: http://svn.boost.org/trac/boost/changeset/63426

Log:
Fix #4254 and other documentation mistakes and bring into closer conformance with the C++ standard library working paper.
Text files modified:
trunk/libs/system/doc/reference.html | 63 ++++++++++++++++++++-------------------
1 files changed, 32 insertions(+), 31 deletions(-)

Modified: trunk/libs/system/doc/reference.html
==============================================================================
--- trunk/libs/system/doc/reference.html (original)
+++ trunk/libs/system/doc/reference.html 2010-06-29 08:33:26 EDT (Tue, 29 Jun 2010)
@@ -370,8 +370,8 @@
<blockquote>
 Returns:  <code>error_condition( ev, *this )</code>.
 <blockquote>
-  [--Note: Derived classes will typically convert <code>ev</code>
- to some portable <code>error_category</code>, such as <code>generic_category</code>,
+  [--Note: Derived classes will typically convert <code>ev</code>
+ to some portable <code>error_category</code>, such as <code>generic_category()</code>,
 and return it as an <code>error_condition</code> for that category. --end
 note]
 </blockquote>
@@ -422,10 +422,6 @@
 identifying portable error conditions.
 Throws: Nothing.
</blockquote>
-<h3><a name="Class-error_category-predefined-objects">Class <code>error_category</code>
-predefined objects</a></h3>
-Predefined objects <code>system_category</code>
-and <code>generic_category</code> identify system specific error codes and portable error conditions, respectively.
<h2><a name="Class-error_code">Class <code>
error_code</code></a></h2>
The class <code>error_code</code> describes an object used to hold error code
@@ -447,14 +443,12 @@
 error_code();
 error_code( val, const error_category & cat );
 template <class <code>ErrorCodeEnum</code>>
- error_code(<code> ErrorCodeEnum</code> e,
- typename enable_if<is_error_code_enum<<code>ErrorCodeEnum</code>> >::type* = 0);
+ error_code(<code> ErrorCodeEnum</code> e );

 // modifiers:
 void assign( int val, const error_category & cat );
 template<typename <code>ErrorCodeEnum</code>>
- typename enable_if<is_error_code_enum<<code>ErrorCodeEnum</code>>, error_code>::type &
- operator=( <code>ErrorCodeEnum</code> val );;
+ error_code & operator=( <code>ErrorCodeEnum</code> val );;
 void clear();

 // observers:
@@ -476,7 +470,7 @@
<pre>error_code();</pre>
<blockquote>
 Effects: Constructs an object of type <code>error_code</code>.
- Postconditions: <code>val_ == 0 && cat_ == &system_category</code>.
+ Postconditions: <code>val_ == 0 && cat_ == &system_category()</code>.
 Throws: Nothing.
</blockquote>
<pre>error_code( int val, const error_category & cat );</pre>
@@ -486,12 +480,14 @@
 Throws: Nothing.
</blockquote>
<pre>template <class <code>ErrorCodeEnum</code>>
- error_code(<code> errorCodeEnum</code> val,
- typename enable_if<is_error_code_enum<<code>ErrorCodeEnum</code>> >::type* = 0);</pre>
+ error_code(<code> ErrorCodeEnum</code> val );</pre>
<blockquote>
 Effects: Constructs an object of type <code>error_code</code>.
 Postconditions: <code>*this == make_error_code( val )</code>.
 Throws: Nothing.
+ Remarks: This constructor shall not participate in overload
+ resolution unless <code>is_error_code_enum<ErrorCodeEnum>::value</code> is
+ <code>true</code>.
</blockquote>
<h3><a name="Class-error_code-modifiers">Class <code>
error_code</code> modifiers</a></h3>
@@ -501,15 +497,17 @@
 Throws: Nothing.
</blockquote>
<pre>template<typename <code>ErrorCodeEnum</code>>
- typename enable_if<is_error_code_enum<<code>ErrorCodeEnum</code>>, error_code>::type &
- operator=( <code>ErrorCodeEnum</code> val );</pre>
+ error_code & operator=( <code>ErrorCodeEnum</code> val );</pre>
<blockquote>
 Postconditions: <code>*this == make_error_code( val )</code>.
 Throws: Nothing.
+ Remarks: This operator shall not participate in overload resolution
+ unless <code>is_error_code_enum<ErrorCodeEnum>::value</code> is <code>true</code>.
</blockquote>
<code>void clear();</code>
<blockquote>
- postcondition: <code>value() == 0 && category() == generic_category</code>
+ postcondition: <code>value() == 0 && category() ==
+ system_category()</code>
</blockquote>
 <h3><a name="Class-error_code-observers">Class <code>
error_code</code> observers</a></h3>
@@ -565,14 +563,12 @@
 error_condition();
 error_condition( int val, const error_category & cat );
 template <class ErrorConditionEnum>
- error_condition( errorConditionEnum val,
- typename enable_if<is_error_condition_enum<ErrorConditionEnum> >::type* = 0 );
+ error_condition( errorConditionEnum val );

 // modifiers:
 void assign( int val, const error_category & cat );
 template<typename ErrorConditionEnum>
- typename enable_if<is_error_condition_enum<ErrorConditionEnum>, error_code>::type &
- operator=( ErrorConditionEnum val );
+ error_condition & operator=( ErrorConditionEnum val );
 void clear();

 // observers:
@@ -593,7 +589,7 @@
<pre>error_condition(); </pre>
<blockquote>
 Effects: Constructs an object of type <code>error_condition</code>.
- Postconditions: <code>val_ == 0 and cat_ == &generic_category</code>.
+ Postconditions: <code>val_ == 0 and cat_ == &generic_category()</code>.
 Throws: Nothing.
</blockquote>
<pre>error_condition( int val, const error_category & cat );</pre>
@@ -603,12 +599,14 @@
 Throws: Nothing.
</blockquote>
<pre>template <class ErrorConditionEnum>
- error_condition( errorConditionEnum val,
- typename enable_if<is_error_condition_enum<ErrorConditionEnum> >::type* = 0 );</pre>
+ error_condition( ErrorConditionEnum e );</pre>
<blockquote>
 Effects: Constructs an object of type <code>error_condition</code>.
- Postconditions: <code>*this == make_error_condition( val )</code>.
+ Postconditions: <code>*this == make_error_condition(e)</code>.
 Throws: Nothing.
+ Remarks: This constructor shall not participate in overload
+ resolution unless <code>is_error_condition_enum<ErrorConditionEnum>::value</code>
+ is <code>true</code>.
</blockquote>
<h3><a name="Class-error_condition-modifiers">Class <code>error_condition</code>
modifiers</a></h3>
@@ -618,15 +616,18 @@
 Throws: Nothing.
</blockquote>
<pre>template<typename ErrorConditionEnum>
- typename enable_if<is_error_condition_enum<ErrorConditionEnum>, error_code>::type &
- operator=( ErrorConditionEnum val );</pre>
+ error_condition & operator=( ErrorConditionEnum e );</pre>
<blockquote>
- Postconditions: <code>*this == make_error_condition( val )</code>.
+ Postconditions: <code>*this == make_error_condition( e )</code>.
+ Returns: <code>*this</code>.
 Throws: Nothing.
+ Remarks: This operator shall not participate in overload resolution
+ unless <code>is_error_condition_enum<ErrorConditionEnum>::value</code> is
+ <code>true</code>.
</blockquote>
<code>void clear();</code>
<blockquote>
- postcondition: <code>value() == 0 && category() == generic_category</code>
+ postcondition: <code>value() == 0 && category() == generic_category()</code>
</blockquote>
<h3><a name="Class-error_condition-observers">Class <code>error_condition</code>
observers</a></h3>
@@ -738,11 +739,11 @@
</blockquote>
<pre>error_code make_error_code( errc::errc_t e );</pre>
<blockquote>
- Returns: <code>error_code( e, generic_category)</code>.
+ Returns: <code>error_code( e, generic_category())</code>.
</blockquote>
<pre>error_condition make_error_condition( errc::errc_t e );</pre>
<blockquote>
- Returns: <code>error_condition( static_cast<int>( e ), generic_category)</code>.
+ Returns: <code>error_condition( static_cast<int>( e ), generic_category())</code>.
</blockquote>

<pre>template <class charT, class traits>
@@ -839,7 +840,7 @@
<hr>

Revised
-May 31, 2010 
+June 29, 2010 


© Copyright Beman Dawes, 2006, 2007, 2008

Next message: bbartmanboost_at_[hidden]: "[Boost-commit] svn:boost r63427 - in sandbox/SOC/2010/bit_masks: boost/integer/details/bft lib/integer/test/bft_testing"
Previous message: david.bellot_at_[hidden]: "[Boost-commit] svn:boost r63425 - branches/ublas-doxygen"

Date view	Thread view	Subject view	Author view

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