Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r49177 - trunk/libs/system/doc
From: bdawes_at_[hidden]
Date: 2008-10-08 10:16:06


Author: bemandawes
Date: 2008-10-08 10:16:05 EDT (Wed, 08 Oct 2008)
New Revision: 49177
URL: http://svn.boost.org/trac/boost/changeset/49177

Log:
System: refine docs for semantics of throws object
Text files modified:
   trunk/libs/system/doc/reference.html | 32 ++++++++++++++++++++------------
   1 files changed, 20 insertions(+), 12 deletions(-)

Modified: trunk/libs/system/doc/reference.html
==============================================================================
--- trunk/libs/system/doc/reference.html (original)
+++ trunk/libs/system/doc/reference.html 2008-10-08 10:16:05 EDT (Wed, 08 Oct 2008)
@@ -619,18 +619,26 @@
 with appropriate namespace qualifiers, have the following error handling
 semantics:</p>
 <blockquote>
- <p><i>Effects:</i> If <code>ec != throws</code>:</p>
- <ul>
- <li>If an error occurs, and sets <code>ec</code> to an appropriate <code>
- error_code</code> that identifies the error
- value and category. The category should be the most specific <code>
- error_category</code> applicable to the
- particular error.</li>
- <li>if an error does not occur, <code>ec.clear()</code>.</li>
- </ul>
- <p><i>Throws:</i> If <code>ec == throws</code>, throws an exception of type
+ <p><i>Postconditions:</i></p>
+ <blockquote>
+ <p>If <code>&amp;ec != &amp;throws</code> and an error occurred:</p>
+ <ul>
+ <li> <code>ec.value()</code> returns the implementation specific error
+ number for the particular error that occurred.</li>
+ <li><code>ec.category()</code> returns the <code>
+ error_category</code> for <code>ec.value()</code>.</li>
+ </ul>
+ <p>if <code>&amp;ec != &amp;throws</code> and an error did not occur, <code>ec.clear()</code>.</p>
+ </blockquote>
+ <p><i>Throws:</i></p>
+ <blockquote>
+ <p>If an error occurs and <code>&amp;ec == &amp;throws</code>, throws an exception of type
   <code>system_error</code> or of a type
- derived from <code>system_error</code>.</p>
+ derived from <code>system_error</code>. The
+ exception's <code>code()</code> member function returns a reference to an
+ <code>error_code</code> object with the behavior specified in <i>
+ Postconditions</i>.</p>
+ </blockquote>
 </blockquote>
 <h2><a name="Non-member-functions">Non-member functions</a></h2>
   <pre>bool operator==( const error_code &amp; lhs, const error_code &amp; rhs );</pre>
@@ -783,7 +791,7 @@
 <hr>
 
 <p>Revised
-<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%B %d, %Y" startspan -->October 05, 2008<!--webbot bot="Timestamp" endspan i-checksum="30983" --> </font>
+<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%B %d, %Y" startspan -->October 08, 2008<!--webbot bot="Timestamp" endspan i-checksum="30989" --> </font>
 </p>
 
 <p>© Copyright Beman Dawes, 2006, 2007, 2008</p>


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