Boost-Commit :

Date view	Thread view	Subject view	Author view

From: nesotto_at_[hidden]
Date: 2008-07-16 16:05:19

Next message: nesotto_at_[hidden]: "[Boost-commit] svn:boost r47486 - trunk/libs/ptr_container/doc"
Previous message: nesotto_at_[hidden]: "[Boost-commit] svn:boost r47484 - trunk/libs/ptr_container/doc"

Author: nesotto
Date: 2008-07-16 16:05:19 EDT (Wed, 16 Jul 2008)
New Revision: 47485
URL: http://svn.boost.org/trac/boost/changeset/47485

Log:
doc update
Text files modified:
   trunk/libs/ptr_container/doc/ptr_sequence_adapter.html | 4 ----
   trunk/libs/ptr_container/doc/ptr_sequence_adapter.rst | 5 -----
   trunk/libs/ptr_container/doc/reference.html | 23 ++++++++++++-----------
   trunk/libs/ptr_container/doc/reference.rst | 25 +++++++++++++------------
   4 files changed, 25 insertions(+), 32 deletions(-)

Modified: trunk/libs/ptr_container/doc/ptr_sequence_adapter.html
==============================================================================
--- trunk/libs/ptr_container/doc/ptr_sequence_adapter.html (original)
+++ trunk/libs/ptr_container/doc/ptr_sequence_adapter.html 2008-07-16 16:05:19 EDT (Wed, 16 Jul 2008)
@@ -467,7 +467,6 @@
<ul class="simple">
<li>Requirements: <tt class="docutils literal">not empty();</tt></li>
<li>Effects: <tt class="docutils literal">return *begin();</tt></li>
-<li>Throws: <tt class="docutils literal">bad_ptr_container_operation</tt> if <tt class="docutils literal">empty() == true</tt></li>
</ul>
</blockquote>
</li>
@@ -476,7 +475,6 @@
<ul class="simple">
<li>Requirements: <tt class="docutils literal">not empty();</tt></li>
<li>Effects: <tt class="docutils literal">return *begin();</tt></li>
-<li>Throws: <tt class="docutils literal">bad_ptr_container_operation</tt> if <tt class="docutils literal">empty() == true</tt></li>
</ul>
</blockquote>
</li>
@@ -485,7 +483,6 @@
<ul class="simple">
<li>Requirements: <tt class="docutils literal">not empty();</tt></li>
<li>Effects: <tt class="docutils literal">return *--end();</tt></li>
-<li>Throws: <tt class="docutils literal">bad_ptr_container_operation</tt> if <tt class="docutils literal">empty() == true</tt></li>
</ul>
</blockquote>
</li>
@@ -494,7 +491,6 @@
<ul class="simple">
<li>Requirements: <tt class="docutils literal">not empty();</tt></li>
<li>Effects: <tt class="docutils literal">return *--end();</tt></li>
-<li>Throws: <tt class="docutils literal">bad_ptr_container_operation</tt> if <tt class="docutils literal">empty() == true</tt></li>
</ul>
</blockquote>
</li>

Modified: trunk/libs/ptr_container/doc/ptr_sequence_adapter.rst
==============================================================================
--- trunk/libs/ptr_container/doc/ptr_sequence_adapter.rst (original)
+++ trunk/libs/ptr_container/doc/ptr_sequence_adapter.rst 2008-07-16 16:05:19 EDT (Wed, 16 Jul 2008)
@@ -197,7 +197,6 @@

     - Effects: ``return *begin();``

- - Throws: ``bad_ptr_container_operation`` if ``empty() == true``

- ``const T& front() const;``

@@ -205,7 +204,6 @@

     - Effects: ``return *begin();``

- - Throws: ``bad_ptr_container_operation`` if ``empty() == true``

- ``T& back();``

@@ -213,7 +211,6 @@

     - Effects: ``return *--end();``

- - Throws: ``bad_ptr_container_operation`` if ``empty() == true``

- ``const T& back() const;``

@@ -221,8 +218,6 @@

     - Effects: ``return *--end();``

- - Throws: ``bad_ptr_container_operation`` if ``empty() == true``
-

.. _`modifiers`:

Modified: trunk/libs/ptr_container/doc/reference.html
==============================================================================
--- trunk/libs/ptr_container/doc/reference.html (original)
+++ trunk/libs/ptr_container/doc/reference.html 2008-07-16 16:05:19 EDT (Wed, 16 Jul 2008)
@@ -294,11 +294,11 @@
each container. When containers have the same interface, that common interface is explained only once,
but links are always provided to more relevant information.
Please make sure you understand
-the <a class="reference" href="reference.html#the-Cloneable-concept">Cloneable</a> concept and
+the <a class="reference" href="reference.html#the-Clonable-concept">Clonable</a> concept and
the <a class="reference" href="reference.html#the-clone-allocator-concept">Clone Allocator</a> concept.
<ul class="simple">
<li><a class="reference" href="conventions.html">Conventions</a></li>
-<li><a class="reference" href="#the-cloneable-concept">The Cloneable concept</a></li>
+<li><a class="reference" href="#the-clonable-concept">The Clonable concept</a></li>
<li><a class="reference" href="#the-clone-allocator-concept">The Clone Allocator concept</a></li>
<li><a class="reference" href="#class-hierarchy">Class hierarchy</a>:<ul>
<li><a class="reference" href="reversible_ptr_container.html">reversible_ptr_container</a><ul>
@@ -328,6 +328,7 @@
</li>
<li><a class="reference" href="#serialization">Serialization</a></li>
<li><a class="reference" href="indirect_fun.html">Indirected functions</a></li>
+<li><a class="reference" href="ptr_inserter.html">Insert iterators</a></li>
<li><a class="reference" href="#class-nullable">Class nullable</a></li>
<li><a class="reference" href="#exception-classes">Exception classes</a></li>
<li><a class="reference" href="#disabling-the-use-of-exceptions">Disabling the use of exceptions</a></li>
@@ -354,16 +355,16 @@
- `ptr_map <ptr_map.html>`_
- `ptr_multimap <ptr_multimap.html>`_ -->
<div class="section">
-<h1><a id="the-cloneable-concept" name="the-cloneable-concept">The Cloneable concept</a></h1>
+<h1><a id="the-clonable-concept" name="the-clonable-concept">The Clonable concept</a></h1>
Refinement of
<ul class="simple">
<li>Heap Allocable</li>
<li>Heap Deallocable</li>
</ul>
-The Cloneable concept is introduced to formalize the requirements for
-copying heap-allocated objects. A type <tt class="docutils literal">T</tt> might be Cloneable even though it
+The Clonable concept is introduced to formalize the requirements for
+copying heap-allocated objects. A type <tt class="docutils literal">T</tt> might be Clonable even though it
is not Assignable or Copy Constructible. Notice that many operations on
-the containers do not even require the stored type to be Cloneable.
+the containers do not even require the stored type to be Clonable.
Notation
<table border="1" class="docutils">
<colgroup>
@@ -381,7 +382,7 @@
<tr><td><tt class="docutils literal">T</tt></td>
<td><tt class="docutils literal">a</tt></td>
<td><tt class="docutils literal">ptr</tt></td>
-<td>A Cloneable type</td>
+<td>A Clonable type</td>
</tr>
</tbody>
</table>
@@ -432,7 +433,7 @@
}
</pre>
Notice that this implementation makes normal Copy Constructible classes automatically
-Cloneable unless <tt class="docutils literal">operator new()</tt> or <tt class="docutils literal">operator delete()</tt> are hidden.
+Clonable unless <tt class="docutils literal">operator new()</tt> or <tt class="docutils literal">operator delete()</tt> are hidden.
The two functions represent a layer of indirection which is necessary to support
classes that are not Copy Constructible by default. Notice that the implementation
relies on argument-dependent lookup (ADL) to find the right version of
@@ -584,7 +585,7 @@
The pointer container adapters are used when you
want to make a pointer container starting from
your own "normal" container. For example, you
-might have a map class that is extends <tt class="docutils literal">std::map</tt>
+might have a map class that extends <tt class="docutils literal">std::map</tt>
in some way; the adapter class then allows you
to use your map class as a basis for a new
pointer container.
@@ -646,7 +647,7 @@
</div>
<div class="section">
<h1><a id="serialization" name="serialization">Serialization</a></h1>
-As of version 1.34.0 of Boost, the library support
+As of version 1.34.0 of Boost, the library supports
serialization via <a class="reference" href="../../serialization/index.html">Boost.Serialization</a>.
Of course, for serialization to work it is required
that the stored type itself is serializable. For maps, both
@@ -786,7 +787,7 @@
completely. This means the library is more fit for domains where exceptions
are not used. Furthermore, it also speeds up a operations a little. Instead
of throwing an exception, the library simply calls <a class="reference" href="../../utility/assert.html">BOOST_ASSERT</a>.
-To disable exceptions, simly define this macro before including any header:
+To disable exceptions, simply define this macro before including any header:
<pre class="literal-block">
#define BOOST_PTR_CONTAINER_NO_EXCEPTIONS 1
#include <boost/ptr_container/ptr_vector.hpp>

Modified: trunk/libs/ptr_container/doc/reference.rst
==============================================================================
--- trunk/libs/ptr_container/doc/reference.rst (original)
+++ trunk/libs/ptr_container/doc/reference.rst 2008-07-16 16:05:19 EDT (Wed, 16 Jul 2008)
@@ -12,11 +12,11 @@
each container. When containers have the same interface, that common interface is explained only once,
but links are always provided to more relevant information.
Please make sure you understand
-the `Cloneable <reference.html#the-Cloneable-concept>`_ concept and
+the `Clonable <reference.html#the-Clonable-concept>`_ concept and
the `Clone Allocator <reference.html#the-clone-allocator-concept>`_ concept.

- `Conventions <conventions.html>`_
-- `The Cloneable concept`_
+- `The Clonable concept`_
- `The Clone Allocator concept`_

- `Class hierarchy`_:
@@ -44,6 +44,7 @@

- `Serialization`_
- `Indirected functions <indirect_fun.html>`_
+- `Insert iterators <ptr_inserter.html>`_
- `Class nullable`_
- `Exception classes`_
- `Disabling the use of exceptions`_
@@ -74,24 +75,24 @@

-The Cloneable concept
-+++++++++++++++++++++
+The Clonable concept
+++++++++++++++++++++

**Refinement of**

- Heap Allocable
- Heap Deallocable

-The Cloneable concept is introduced to formalize the requirements for
-copying heap-allocated objects. A type ``T`` might be Cloneable even though it
+The Clonable concept is introduced to formalize the requirements for
+copying heap-allocated objects. A type ``T`` might be Clonable even though it
is not Assignable or Copy Constructible. Notice that many operations on
-the containers do not even require the stored type to be Cloneable.
+the containers do not even require the stored type to be Clonable.

**Notation**

======================= ============================================ =================== =====================
 **Type** **Object** (``const`` or non-``const``) **Pointer** **Describes**
- ``T`` ``a`` ``ptr`` A Cloneable type
+ ``T`` ``a`` ``ptr`` A Clonable type
======================= ============================================ =================== =====================

**Valid expressions**
@@ -128,7 +129,7 @@

Notice that this implementation makes normal Copy Constructible classes automatically
-Cloneable unless ``operator new()`` or ``operator delete()`` are hidden.
+Clonable unless ``operator new()`` or ``operator delete()`` are hidden.

The two functions represent a layer of indirection which is necessary to support
classes that are not Copy Constructible by default. Notice that the implementation
@@ -260,7 +261,7 @@
The pointer container adapters are used when you
want to make a pointer container starting from
your own "normal" container. For example, you
-might have a map class that is extends ``std::map``
+might have a map class that extends ``std::map``
in some way; the adapter class then allows you
to use your map class as a basis for a new
pointer container.
@@ -318,7 +319,7 @@
Serialization
+++++++++++++

-As of version 1.34.0 of Boost, the library support
+As of version 1.34.0 of Boost, the library supports
serialization via `Boost.Serialization`__.

.. __: ../../serialization/index.html
@@ -471,7 +472,7 @@

.. __: ../../utility/assert.html

-To disable exceptions, simly define this macro before including any header::
+To disable exceptions, simply define this macro before including any header::

 #define BOOST_PTR_CONTAINER_NO_EXCEPTIONS 1
 #include <boost/ptr_container/ptr_vector.hpp>

Next message: nesotto_at_[hidden]: "[Boost-commit] svn:boost r47486 - trunk/libs/ptr_container/doc"
Previous message: nesotto_at_[hidden]: "[Boost-commit] svn:boost r47484 - trunk/libs/ptr_container/doc"

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