boostorg/functional
1
0
Fork 1
mirror of https://github.com/boostorg/functional.git synced 2025-08-02 14:04:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

Use paragraphs inside purpose tags.

Browse Source 
[SVN r51802]
This commit is contained in:
Daniel James
2009-03-16 20:21:05 +00:00
parent 1c44695b87
commit bb3e603cfe
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
hash/doc/ref.xml
View File

@@ -34,7 +34,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
<classname>std::unary_function&lt;T, std::size_t&gt;</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 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
<type>void</type>
<parameter name="seed"><paramtype>size_t &amp;</paramtype></parameter>
<parameter name="v"><paramtype>T const&amp;</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 &lt;&lt; 6) + (seed &gt;&gt; 2);</programlisting></effects>
<notes>
<para><functionname>hash_value</functionname> is called without
@@ -460,10 +460,10 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
<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 @@ for(; first != last; ++first)
-->
<overloaded-function name="hash_value">
<purpose>
<purpose><simpara>
Implementation of the hash function.
</purpose>
</simpara></purpose>
<signature>
<type>std::size_t</type>