|
|
Boost-Commit : |
From: daniel_james_at_[hidden]
Date: 2008-03-29 10:56:00
Author: danieljames
Date: 2008-03-29 10:55:59 EDT (Sat, 29 Mar 2008)
New Revision: 43922
URL: http://svn.boost.org/trac/boost/changeset/43922
Log:
Fix some typos in the reference documentation.
Text files modified:
branches/unordered/trunk/libs/unordered/doc/ref.xml | 98 ++++++++++++++-------------------------
1 files changed, 36 insertions(+), 62 deletions(-)
Modified: branches/unordered/trunk/libs/unordered/doc/ref.xml
==============================================================================
--- branches/unordered/trunk/libs/unordered/doc/ref.xml (original)
+++ branches/unordered/trunk/libs/unordered/doc/ref.xml 2008-03-29 10:55:59 EDT (Sat, 29 Mar 2008)
@@ -2,20 +2,9 @@
Copyright Daniel James 2006-2008
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)
--->
-
- <library-reference>
- <!--
- Header: <boost/unordered_set.hpp>
- -->
-
+--><library-reference>
<header name="boost/unordered_set.hpp">
<namespace name="boost">
-
- <!--
- boost::unordered_set
- -->
-
<class name="unordered_set">
<template>
<template-type-parameter name="Value">
@@ -30,10 +19,11 @@
<default><type>std::allocator<Value></type></default>
</template-type-parameter>
</template>
- <purpose>An unordered associative container that stores unique values.
+ <purpose>
+ An unordered associative container that stores unique values.
</purpose>
<description>
- <para>For the normative reference see chapter 23 of
+ <para>For the normative reference see chapter 23 of
<ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2461.pdf">the working draft of the C++ standard [n2461].</ulink></para>
<para><emphasis role="bold">Template Parameters</emphasis>
<informaltable>
@@ -48,7 +38,7 @@
<row>
<entry><emphasis>Pred</emphasis></entry>
<entry>A binary function object that implements an equivalence relation on values of type <code>Value</code>.
- A binary function object that induces an equivalence relation on values of type Key.
+ A binary function object that induces an equivalence relation on values of type Key.
It takes two arguments of type Key and returns a value of type bool.</entry></row>
<row>
<entry><emphasis>Alloc</emphasis></entry>
@@ -391,7 +381,7 @@
<para>If the allocators are equal, doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>key_equal</code> or <code>hasher</code>.</para>
</throws>
<notes>
- <para>For a discussion of the behavior when allocators aren't equal see
+ <para>For a discussion of the behavior when allocators aren't equal see
<link linkend="unordered.rationale.swapping_containers_with_unequal_allocators">the implementation details</link>.</para>
</notes>
</method>
@@ -620,17 +610,12 @@
<para>If the allocators are equal, doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>Hash</code> or <code>Pred</code>.</para>
</throws>
<notes>
- <para>For a discussion of the behavior when allocators aren't equal see
+ <para>For a discussion of the behavior when allocators aren't equal see
<link linkend="unordered.rationale.swapping_containers_with_unequal_allocators">the implementation details</link>.</para>
</notes>
</function>
</free-function-group>
</class>
-
- <!--
- boost::unordered_multiset
- -->
-
<class name="unordered_multiset">
<template>
<template-type-parameter name="Value">
@@ -645,10 +630,11 @@
<default><type>std::allocator<Value></type></default>
</template-type-parameter>
</template>
- <purpose>An unordered associative container that stores values. The same key can be stored multiple times.
+ <purpose>
+ An unordered associative container that stores values. The same key can be stored multiple times.
</purpose>
<description>
- <para>For the normative reference see chapter 23 of
+ <para>For the normative reference see chapter 23 of
<ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2461.pdf">the working draft of the C++ standard [n2461].</ulink></para>
<para><emphasis role="bold">Template Parameters</emphasis>
<informaltable>
@@ -663,7 +649,7 @@
<row>
<entry><emphasis>Pred</emphasis></entry>
<entry>A binary function object that implements an equivalence relation on values of type <code>Value</code>.
- A binary function object that induces an equivalence relation on values of type Key.
+ A binary function object that induces an equivalence relation on values of type Key.
It takes two arguments of type Key and returns a value of type bool.</entry></row>
<row>
<entry><emphasis>Alloc</emphasis></entry>
@@ -924,7 +910,7 @@
</parameter>
<type>void</type>
<description>
- <para>Inserts a range of elements into the container. </para>
+ <para>Inserts a range of elements into the container.</para>
</description>
<throws>
<para>When inserting a single element, if an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
@@ -1005,7 +991,7 @@
<para>If the allocators are equal, doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>key_equal</code> or <code>hasher</code>.</para>
</throws>
<notes>
- <para>For a discussion of the behavior when allocators aren't equal see
+ <para>For a discussion of the behavior when allocators aren't equal see
<link linkend="unordered.rationale.swapping_containers_with_unequal_allocators">the implementation details</link>.</para>
</notes>
</method>
@@ -1234,7 +1220,7 @@
<para>If the allocators are equal, doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>Hash</code> or <code>Pred</code>.</para>
</throws>
<notes>
- <para>For a discussion of the behavior when allocators aren't equal see
+ <para>For a discussion of the behavior when allocators aren't equal see
<link linkend="unordered.rationale.swapping_containers_with_unequal_allocators">the implementation details</link>.</para>
</notes>
</function>
@@ -1242,17 +1228,8 @@
</class>
</namespace>
</header>
- <!--
- Header: <boost/unordered_map.hpp>
- -->
-
<header name="boost/unordered_map.hpp">
<namespace name="boost">
-
- <!--
- boost::unordered_map
- -->
-
<class name="unordered_map">
<template>
<template-type-parameter name="Key">
@@ -1260,19 +1237,20 @@
<template-type-parameter name="Mapped">
</template-type-parameter>
<template-type-parameter name="Hash">
- <default><type>boost::hash<Value></type></default>
+ <default><type>boost::hash<Key></type></default>
</template-type-parameter>
<template-type-parameter name="Pred">
- <default><type>std::equal_to<Value></type></default>
+ <default><type>std::equal_to<Key></type></default>
</template-type-parameter>
<template-type-parameter name="Alloc">
- <default><type>std::allocator<std::pair<const Key, Mapped> ></type></default>
+ <default><type>std::allocator<std::pair<Key const, Mapped> ></type></default>
</template-type-parameter>
</template>
- <purpose>An unordered associative container that associates unique keys with another value.
+ <purpose>
+ An unordered associative container that associates unique keys with another value.
</purpose>
<description>
- <para>For the normative reference see chapter 23 of
+ <para>For the normative reference see chapter 23 of
<ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2461.pdf">the working draft of the C++ standard [n2461].</ulink></para>
<para><emphasis role="bold">Template Parameters</emphasis>
<informaltable>
@@ -1290,7 +1268,7 @@
<row>
<entry><emphasis>Pred</emphasis></entry>
<entry>A binary function object that implements an equivalence relation on values of type <code>Key</code>.
- A binary function object that induces an equivalence relation on values of type Key.
+ A binary function object that induces an equivalence relation on values of type Key.
It takes two arguments of type Key and returns a value of type bool.</entry></row>
<row>
<entry><emphasis>Alloc</emphasis></entry>
@@ -1302,7 +1280,7 @@
<type>Key</type>
</typedef>
<typedef name="value_type">
- <type>std::pair<Key const, Value></type>
+ <type>std::pair<Key const, Mapped></type>
</typedef>
<typedef name="mapped_type">
<type>Mapped</type>
@@ -1636,7 +1614,7 @@
<para>If the allocators are equal, doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>key_equal</code> or <code>hasher</code>.</para>
</throws>
<notes>
- <para>For a discussion of the behavior when allocators aren't equal see
+ <para>For a discussion of the behavior when allocators aren't equal see
<link linkend="unordered.rationale.swapping_containers_with_unequal_allocators">the implementation details</link>.</para>
</notes>
</method>
@@ -1731,7 +1709,7 @@
<para>An exception object of type <code>std::out_of_range</code> if no such element is present.</para>
</throws>
<notes>
- <para>This is not specified in the draft standard, but that is probably an oversight. The issue has been raised in
+ <para>This is not specified in the draft standard, but that is probably an oversight. The issue has been raised in
<ulink url="http://groups.google.com/group/comp.std.c++/browse_thread/thread/ab7c22a868fd370b">comp.std.c++</ulink>.</para>
</notes>
</overloaded-method>
@@ -1902,17 +1880,12 @@
<para>If the allocators are equal, doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>Hash</code> or <code>Pred</code>.</para>
</throws>
<notes>
- <para>For a discussion of the behavior when allocators aren't equal see
+ <para>For a discussion of the behavior when allocators aren't equal see
<link linkend="unordered.rationale.swapping_containers_with_unequal_allocators">the implementation details</link>.</para>
</notes>
</function>
</free-function-group>
</class>
-
- <!--
- boost::unordered_multimap
- -->
-
<class name="unordered_multimap">
<template>
<template-type-parameter name="Key">
@@ -1920,19 +1893,20 @@
<template-type-parameter name="Mapped">
</template-type-parameter>
<template-type-parameter name="Hash">
- <default><type>boost::hash<Value></type></default>
+ <default><type>boost::hash<Key></type></default>
</template-type-parameter>
<template-type-parameter name="Pred">
- <default><type>std::equal_to<Value></type></default>
+ <default><type>std::equal_to<Key></type></default>
</template-type-parameter>
<template-type-parameter name="Alloc">
- <default><type>std::allocator<std::pair<const Key, Mapped> ></type></default>
+ <default><type>std::allocator<std::pair<Key const, Mapped> ></type></default>
</template-type-parameter>
</template>
- <purpose>An unordered associative container that associates keys with another value. The same key can be stored multiple times.
+ <purpose>
+ An unordered associative container that associates keys with another value. The same key can be stored multiple times.
</purpose>
<description>
- <para>For the normative reference see chapter 23 of
+ <para>For the normative reference see chapter 23 of
<ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2461.pdf">the working draft of the C++ standard [n2461].</ulink></para>
<para><emphasis role="bold">Template Parameters</emphasis>
<informaltable>
@@ -1950,7 +1924,7 @@
<row>
<entry><emphasis>Pred</emphasis></entry>
<entry>A binary function object that implements an equivalence relation on values of type <code>Key</code>.
- A binary function object that induces an equivalence relation on values of type Key.
+ A binary function object that induces an equivalence relation on values of type Key.
It takes two arguments of type Key and returns a value of type bool.</entry></row>
<row>
<entry><emphasis>Alloc</emphasis></entry>
@@ -1962,7 +1936,7 @@
<type>Key</type>
</typedef>
<typedef name="value_type">
- <type>std::pair<Key const, Value></type>
+ <type>std::pair<Key const, Mapped></type>
</typedef>
<typedef name="mapped_type">
<type>Mapped</type>
@@ -2214,7 +2188,7 @@
</parameter>
<type>void</type>
<description>
- <para>Inserts a range of elements into the container. </para>
+ <para>Inserts a range of elements into the container.</para>
</description>
<throws>
<para>When inserting a single element, if an exception is thrown by an operation other than a call to <code>hasher</code> the function has no effect.</para>
@@ -2295,7 +2269,7 @@
<para>If the allocators are equal, doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>key_equal</code> or <code>hasher</code>.</para>
</throws>
<notes>
- <para>For a discussion of the behavior when allocators aren't equal see
+ <para>For a discussion of the behavior when allocators aren't equal see
<link linkend="unordered.rationale.swapping_containers_with_unequal_allocators">the implementation details</link>.</para>
</notes>
</method>
@@ -2526,7 +2500,7 @@
<para>If the allocators are equal, doesn't throw an exception unless it is thrown by the copy constructor or copy assignment operator of <code>Hash</code> or <code>Pred</code>.</para>
</throws>
<notes>
- <para>For a discussion of the behavior when allocators aren't equal see
+ <para>For a discussion of the behavior when allocators aren't equal see
<link linkend="unordered.rationale.swapping_containers_with_unequal_allocators">the implementation details</link>.</para>
</notes>
</function>
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