|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r71052 - in trunk/libs/optional/doc: . html html/boost_optional
From: steven_at_[hidden]
Date: 2011-04-06 17:56:24
Author: steven_watanabe
Date: 2011-04-06 17:56:23 EDT (Wed, 06 Apr 2011)
New Revision: 71052
URL: http://svn.boost.org/trac/boost/changeset/71052
Log:
Copy-editing optional documentation. Fixes #5382 and a few other issues I noticed while I was at it.
Text files modified:
trunk/libs/optional/doc/development.qbk | 8 ++++----
trunk/libs/optional/doc/html/boost_optional/detailed_semantics.html | 5 ++---
trunk/libs/optional/doc/html/boost_optional/development.html | 6 +++---
trunk/libs/optional/doc/html/index.html | 6 +++---
trunk/libs/optional/doc/optional.qbk | 2 +-
trunk/libs/optional/doc/reference.qbk | 4 ++--
6 files changed, 15 insertions(+), 16 deletions(-)
Modified: trunk/libs/optional/doc/development.qbk
==============================================================================
--- trunk/libs/optional/doc/development.qbk (original)
+++ trunk/libs/optional/doc/development.qbk 2011-04-06 17:56:23 EDT (Wed, 06 Apr 2011)
@@ -1,4 +1,4 @@
-[/
+[/
Boost.Optional
Copyright (c) 2003-2007 Fernando Luis Cacciola Carballal
@@ -58,7 +58,7 @@
additional `nil_t` with respect to [_purpose] of `optional<T>` suggests an
alternative model: a ['container] that either has a value of `T` or nothing.
-As of this writing I don't know of any precedence for a variable-size
+As of this writing I don't know of any precedent for a variable-size
fixed-capacity (of 1) stack-based container model for optional values, yet I
believe this is the consequence of the lack of practical implementations of
such a container rather than an inherent shortcoming of the container model.
@@ -176,14 +176,14 @@
A relevant feature of a pointer is that it can have a [*null pointer value].
This is a ['special] value which is used to indicate that the pointer is not
referring to any object at all. In other words, null pointer values convey
-the notion of inexistent objects.
+the notion of nonexistent objects.
This meaning of the null pointer value allowed pointers to became a ['de
facto] standard for handling optional objects because all you have to do
to refer to a value which you don't really have is to use a null pointer
value of the appropriate type. Pointers have been used for decades—from
the days of C APIs to modern C++ libraries—to ['refer] to optional (that is,
-possibly inexistent) objects; particularly as optional arguments to a
+possibly nonexistent) objects; particularly as optional arguments to a
function, but also quite often as optional data members.
The possible presence of a null pointer value makes the operations that
Modified: trunk/libs/optional/doc/html/boost_optional/detailed_semantics.html
==============================================================================
--- trunk/libs/optional/doc/html/boost_optional/detailed_semantics.html (original)
+++ trunk/libs/optional/doc/html/boost_optional/detailed_semantics.html 2011-04-06 17:56:23 EDT (Wed, 06 Apr 2011)
@@ -217,8 +217,7 @@
otherwise, same as:
</li></ul></div>
<div class="blockquote"><blockquote class="blockquote"><p>
- <code class="computeroutput"><span class="identifier">optional</span><span class="special"><</span><span class="identifier">T</span> <span class="special">[</span><span class="error">'</span><span class="special">(</span><span class="keyword">not</span> <span class="identifier">a</span>
- <span class="identifier">ref</span><span class="special">)]>::</span><span class="identifier">optional</span><span class="special">()</span></code>
+ <code class="computeroutput"><span class="identifier">optional</span><span class="special"><</span><span class="identifier">T</span> </code><span class="emphasis"><em>(not a ref)</em></span><code class="computeroutput"><span class="special">>::</span><span class="identifier">optional</span><span class="special">()</span></code>
</p></blockquote></div>
<div class="blockquote"><blockquote class="blockquote"><p>
<code class="computeroutput"><span class="identifier">optional</span><span class="special"><</span><span class="identifier">T</span><span class="special">&></span> <span class="special">::</span><span class="identifier">optional</span><span class="special">()</span></code>
@@ -712,7 +711,7 @@
<span class="bold"><strong>Exception Safety:</strong></span> Exceptions can only
be thrown during the call to the <code class="computeroutput"><span class="identifier">T</span></code>
constructor used by the factory; in that case, the <code class="computeroutput"><span class="identifier">optional</span></code>
- object will be left empty.
+ object will be reset to be <span class="emphasis"><em>uninitialized</em></span>.
</li>
</ul></div>
<p>
Modified: trunk/libs/optional/doc/html/boost_optional/development.html
==============================================================================
--- trunk/libs/optional/doc/html/boost_optional/development.html (original)
+++ trunk/libs/optional/doc/html/boost_optional/development.html 2011-04-06 17:56:23 EDT (Wed, 06 Apr 2011)
@@ -96,7 +96,7 @@
value of <code class="computeroutput"><span class="identifier">T</span></code> or nothing.
</p>
<p>
- As of this writing I don't know of any precedence for a variable-size fixed-capacity
+ As of this writing I don't know of any precedent for a variable-size fixed-capacity
(of 1) stack-based container model for optional values, yet I believe this
is the consequence of the lack of practical implementations of such a container
rather than an inherent shortcoming of the container model.
@@ -302,7 +302,7 @@
A relevant feature of a pointer is that it can have a <span class="bold"><strong>null
pointer value</strong></span>. This is a <span class="emphasis"><em>special</em></span> value which
is used to indicate that the pointer is not referring to any object at all.
- In other words, null pointer values convey the notion of inexistent objects.
+ In other words, null pointer values convey the notion of nonexistent objects.
</p>
<p>
This meaning of the null pointer value allowed pointers to became a <span class="emphasis"><em>de
@@ -310,7 +310,7 @@
to do to refer to a value which you don't really have is to use a null pointer
value of the appropriate type. Pointers have been used for decades—from
the days of C APIs to modern C++ libraries—to <span class="emphasis"><em>refer</em></span>
- to optional (that is, possibly inexistent) objects; particularly as optional
+ to optional (that is, possibly nonexistent) objects; particularly as optional
arguments to a function, but also quite often as optional data members.
</p>
<p>
Modified: trunk/libs/optional/doc/html/index.html
==============================================================================
--- trunk/libs/optional/doc/html/index.html (original)
+++ trunk/libs/optional/doc/html/index.html 2011-04-06 17:56:23 EDT (Wed, 06 Apr 2011)
@@ -27,7 +27,7 @@
</h3></div></div>
<div><p class="copyright">Copyright © 2003-2007 Fernando Luis Cacciola Carballal</p></div>
<div><div class="legalnotice">
-<a name="id3012019"></a><p>
+<a name="id2854050"></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>
@@ -145,7 +145,7 @@
<span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">point</span><span class="special">,</span><span class="keyword">bool</span><span class="special">></span> <span class="identifier">polygon</span><span class="special">::</span><span class="identifier">get_any_point_effectively_inside</span><span class="special">();</span>
</pre>
<p>
- These functions use a consistent interface for dealing with possibly inexistent
+ These functions use a consistent interface for dealing with possibly nonexistent
results:
</p>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">point</span><span class="special">,</span><span class="keyword">bool</span><span class="special">></span> <span class="identifier">p</span> <span class="special">=</span> <span class="identifier">poly</span><span class="special">.</span><span class="identifier">get_any_point_effectively_inside</span><span class="special">();</span>
@@ -163,7 +163,7 @@
</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: April 06, 2011 at 20:44:42 GMT</small></p></td>
+<td align="left"><p><small>Last revised: April 06, 2011 at 21:53:26 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
Modified: trunk/libs/optional/doc/optional.qbk
==============================================================================
--- trunk/libs/optional/doc/optional.qbk (original)
+++ trunk/libs/optional/doc/optional.qbk 2011-04-06 17:56:23 EDT (Wed, 06 Apr 2011)
@@ -99,7 +99,7 @@
std::pair<char,bool> get_async_input();
std::pair<point,bool> polygon::get_any_point_effectively_inside();
-These functions use a consistent interface for dealing with possibly inexistent
+These functions use a consistent interface for dealing with possibly nonexistent
results:
std::pair<point,bool> p = poly.get_any_point_effectively_inside();
Modified: trunk/libs/optional/doc/reference.qbk
==============================================================================
--- trunk/libs/optional/doc/reference.qbk (original)
+++ trunk/libs/optional/doc/reference.qbk 2011-04-06 17:56:23 EDT (Wed, 06 Apr 2011)
@@ -232,7 +232,7 @@
* otherwise, same as:
-[: `optional<T ['(not a ref)]>::optional()`]
+[: `optional<T `['(not a ref)]`>::optional()`]
[: `optional<T&> ::optional()`]
__SPACE__
@@ -513,7 +513,7 @@
* [*Notes:] See [link boost_optional.in_place_factories In-Place Factories]
* [*Exception Safety:] Exceptions can only be thrown during the call to
the `T` constructor used by the factory; in that case, the `optional` object
-will be left empty.
+will be reset to be ['uninitialized].
__SPACE__
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