From c1d2381a9b17f8900b0af088b79f9e144cdb4bc0 Mon Sep 17 00:00:00 2001 From: Steven Watanabe Date: Wed, 6 Apr 2011 21:56:23 +0000 Subject: [PATCH] Copy-editing optional documentation. Fixes #5382 and a few other issues I noticed while I was at it. [SVN r71052] --- doc/development.qbk | 8 ++++---- doc/html/boost_optional/detailed_semantics.html | 5 ++--- doc/html/boost_optional/development.html | 6 +++--- doc/html/index.html | 6 +++--- doc/optional.qbk | 2 +- doc/reference.qbk | 4 ++-- 6 files changed, 15 insertions(+), 16 deletions(-) diff --git a/doc/development.qbk b/doc/development.qbk index cd00e45..9340407 100644 --- a/doc/development.qbk +++ b/doc/development.qbk @@ -1,4 +1,4 @@ -[/ +[/ Boost.Optional Copyright (c) 2003-2007 Fernando Luis Cacciola Carballal @@ -58,7 +58,7 @@ The observation made in the last paragraph about the irrelevant nature of the additional `nil_t` with respect to [_purpose] of `optional` 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 @@ untitialized optional objects: The operators * and ->] 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 diff --git a/doc/html/boost_optional/detailed_semantics.html b/doc/html/boost_optional/detailed_semantics.html index e48adcb..311e243 100644 --- a/doc/html/boost_optional/detailed_semantics.html +++ b/doc/html/boost_optional/detailed_semantics.html @@ -217,8 +217,7 @@ otherwise, same as:

- optional<T ['(not a - ref)]>::optional() + optional<T (not a ref)>::optional()

optional<T&> ::optional() @@ -712,7 +711,7 @@ 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. + object will be reset to be uninitialized.

diff --git a/doc/html/boost_optional/development.html b/doc/html/boost_optional/development.html index 159fd33..4c870d6 100644 --- a/doc/html/boost_optional/development.html +++ b/doc/html/boost_optional/development.html @@ -96,7 +96,7 @@ value of T or nothing.

- 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 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. + In other words, null pointer values convey the notion of nonexistent objects.

This meaning of the null pointer value allowed pointers to became a 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 refer - 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.

diff --git a/doc/html/index.html b/doc/html/index.html index 14c4e6a..0ea03c2 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -27,7 +27,7 @@

Copyright © 2003-2007 Fernando Luis Cacciola Carballal

-

+

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)

@@ -145,7 +145,7 @@ 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();
@@ -163,7 +163,7 @@
- +

Last revised: April 06, 2011 at 20:44:42 GMT

Last revised: April 06, 2011 at 21:53:26 GMT
diff --git a/doc/optional.qbk b/doc/optional.qbk index 5217e49..fc65f14 100644 --- a/doc/optional.qbk +++ b/doc/optional.qbk @@ -99,7 +99,7 @@ functions could have the following interface: std::pair get_async_input(); std::pair 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 p = poly.get_any_point_effectively_inside(); diff --git a/doc/reference.qbk b/doc/reference.qbk index 97abcad..d1c9221 100644 --- a/doc/reference.qbk +++ b/doc/reference.qbk @@ -232,7 +232,7 @@ __SPACE__ * otherwise, same as: -[: `optional::optional()`] +[: `optional::optional()`] [: `optional ::optional()`] __SPACE__ @@ -513,7 +513,7 @@ from the factory `f` (i.e., the value [_is not copied]). * [*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__