|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r51802 - in trunk/libs: functional/hash/doc unordered/doc
From: daniel_james_at_[hidden]
Date: 2009-03-16 16:21:05
Author: danieljames
Date: 2009-03-16 16:21:05 EDT (Mon, 16 Mar 2009)
New Revision: 51802
URL: http://svn.boost.org/trac/boost/changeset/51802
Log:
Use paragraphs inside purpose tags.
Text files modified:
trunk/libs/functional/hash/doc/ref.xml | 14 +++++++-------
trunk/libs/unordered/doc/ref.xml | 32 ++++++++++++++++----------------
2 files changed, 23 insertions(+), 23 deletions(-)
Modified: trunk/libs/functional/hash/doc/ref.xml
==============================================================================
--- trunk/libs/functional/hash/doc/ref.xml (original)
+++ trunk/libs/functional/hash/doc/ref.xml 2009-03-16 16:21:05 EDT (Mon, 16 Mar 2009)
@@ -34,7 +34,7 @@
<classname>std::unary_function<T, std::size_t></classname>
</inherit>
- <purpose>A <ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2005/n1836.pdf">TR1</ulink> compliant hash function object.</purpose>
+ <purpose><simpara>A <ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2005/n1836.pdf">TR1</ulink> compliant hash function object.</simpara></purpose>
<method name="operator()" cv="const">
<type>std::size_t</type>
@@ -419,10 +419,10 @@
<type>void</type>
<parameter name="seed"><paramtype>size_t &</paramtype></parameter>
<parameter name="v"><paramtype>T const&</paramtype></parameter>
- <purpose>
+ <purpose><simpara>
Called repeatedly to incrementally create a hash value from
several variables.
- </purpose>
+ </simpara></purpose>
<effects><programlisting>seed ^= <functionname>hash_value</functionname>(v) + 0x9e3779b9 + (seed << 6) + (seed >> 2);</programlisting></effects>
<notes>
<para><functionname>hash_value</functionname> is called without
@@ -460,10 +460,10 @@
<parameter name="last"><paramtype>It</paramtype></parameter>
</signature>
- <purpose>
+ <purpose><simpara>
Calculate the combined hash value of the elements of an iterator
range.
- </purpose>
+ </simpara></purpose>
<effects>
<para>For the two argument overload:
<programlisting>
@@ -511,9 +511,9 @@
-->
<overloaded-function name="hash_value">
- <purpose>
+ <purpose><simpara>
Implementation of the hash function.
- </purpose>
+ </simpara></purpose>
<signature>
<type>std::size_t</type>
Modified: trunk/libs/unordered/doc/ref.xml
==============================================================================
--- trunk/libs/unordered/doc/ref.xml (original)
+++ trunk/libs/unordered/doc/ref.xml 2009-03-16 16:21:05 EDT (Mon, 16 Mar 2009)
@@ -19,9 +19,9 @@
<default><type>std::allocator<Value></type></default>
</template-type-parameter>
</template>
- <purpose>
+ <purpose><simpara>
An unordered associative container that stores unique values.
- </purpose>
+ </simpara></purpose>
<description>
<para>For the normative reference see chapter 23 of
<ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008-2009/n2691.pdf">the working draft of the C++ standard [n2691].</ulink></para>
@@ -69,11 +69,11 @@
</typedef>
<typedef name="reference">
<type>typename allocator_type::reference</type>
- <purpose>lvalue of <type>value_type</type>.</purpose>
+ <purpose><simpara>lvalue of <type>value_type</type>.</simpara></purpose>
</typedef>
<typedef name="const_reference">
<type>typename allocator_type::const_reference</type>
- <purpose>const lvalue of <type>value_type</type>.</purpose>
+ <purpose><simpara>const lvalue of <type>value_type</type>.</simpara></purpose>
</typedef>
<typedef name="size_type">
<type><emphasis>implementation-defined</emphasis></type>
@@ -753,9 +753,9 @@
<default><type>std::allocator<Value></type></default>
</template-type-parameter>
</template>
- <purpose>
+ <purpose><simpara>
An unordered associative container that stores values. The same key can be stored multiple times.
- </purpose>
+ </simpara></purpose>
<description>
<para>For the normative reference see chapter 23 of
<ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008-2009/n2691.pdf">the working draft of the C++ standard [n2691].</ulink></para>
@@ -803,11 +803,11 @@
</typedef>
<typedef name="reference">
<type>typename allocator_type::reference</type>
- <purpose>lvalue of <type>value_type</type>.</purpose>
+ <purpose><simpara>lvalue of <type>value_type</type>.</simpara></purpose>
</typedef>
<typedef name="const_reference">
<type>typename allocator_type::const_reference</type>
- <purpose>const lvalue of <type>value_type</type>.</purpose>
+ <purpose><simpara>const lvalue of <type>value_type</type>.</simpara></purpose>
</typedef>
<typedef name="size_type">
<type><emphasis>implementation-defined</emphasis></type>
@@ -1491,9 +1491,9 @@
<default><type>std::allocator<std::pair<Key const, Mapped> ></type></default>
</template-type-parameter>
</template>
- <purpose>
+ <purpose><simpara>
An unordered associative container that associates unique keys with another value.
- </purpose>
+ </simpara></purpose>
<description>
<para>For the normative reference see chapter 23 of
<ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008-2009/n2691.pdf">the working draft of the C++ standard [n2691].</ulink></para>
@@ -1547,11 +1547,11 @@
</typedef>
<typedef name="reference">
<type>typename allocator_type::reference</type>
- <purpose>lvalue of <type>value_type</type>.</purpose>
+ <purpose><simpara>lvalue of <type>value_type</type>.</simpara></purpose>
</typedef>
<typedef name="const_reference">
<type>typename allocator_type::const_reference</type>
- <purpose>const lvalue of <type>value_type</type>.</purpose>
+ <purpose><simpara>const lvalue of <type>value_type</type>.</simpara></purpose>
</typedef>
<typedef name="size_type">
<type><emphasis>implementation-defined</emphasis></type>
@@ -2274,9 +2274,9 @@
<default><type>std::allocator<std::pair<Key const, Mapped> ></type></default>
</template-type-parameter>
</template>
- <purpose>
+ <purpose><simpara>
An unordered associative container that associates keys with another value. The same key can be stored multiple times.
- </purpose>
+ </simpara></purpose>
<description>
<para>For the normative reference see chapter 23 of
<ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008-2009/n2691.pdf">the working draft of the C++ standard [n2691].</ulink></para>
@@ -2330,11 +2330,11 @@
</typedef>
<typedef name="reference">
<type>typename allocator_type::reference</type>
- <purpose>lvalue of <type>value_type</type>.</purpose>
+ <purpose><simpara>lvalue of <type>value_type</type>.</simpara></purpose>
</typedef>
<typedef name="const_reference">
<type>typename allocator_type::const_reference</type>
- <purpose>const lvalue of <type>value_type</type>.</purpose>
+ <purpose><simpara>const lvalue of <type>value_type</type>.</simpara></purpose>
</typedef>
<typedef name="size_type">
<type><emphasis>implementation-defined</emphasis></type>
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