From 0ea847a64e07eab02b4c19b1a689e8b0446b2c26 Mon Sep 17 00:00:00 2001
From: Daniel James <daniel@calamity.org.uk>
Date: Fri, 2 Sep 2011 08:29:23 +0000
Subject: [PATCH] Unordered: Documentation changes.

[SVN r74194]
---
 doc/hash_equality.qbk | 3 ++-
 doc/ref.php           | 2 ++
 doc/ref.xml           | 8 ++++++++
 3 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/doc/hash_equality.qbk b/doc/hash_equality.qbk
index 823cf8cc..c13fcc48 100644
--- a/doc/hash_equality.qbk
+++ b/doc/hash_equality.qbk
@@ -67,7 +67,8 @@ so that the hash function doesn't need to be explicitly given:
 
 See the [link hash.custom Boost.Hash documentation] for more detail on how to
 do this.  Remember that it relies on extensions to the draft standard - so it
-won't work on other implementations of the unordered associative containers.
+won't work for other implementations of the unordered associative containers,
+you'll need to explicitly use Boost.Hash.
 
 [table:access_methods Methods for accessing the hash and equality functions.
     [[Method] [Description]]
diff --git a/doc/ref.php b/doc/ref.php
index b312f2d4..531d53d2 100644
--- a/doc/ref.php
+++ b/doc/ref.php
@@ -962,6 +962,7 @@ EOL;
               </parameter>
               <type>bool</type>
               <notes>
+                <para><emphasis>TODO</emphasis>: Documentation outdated.</para>
                 <para>This is a boost extension.</para>
                 <para>Behavior is undefined if the two containers don't have
                     equivalent equality predicates.</para>
@@ -985,6 +986,7 @@ EOL;
               </parameter>
               <type>bool</type>
               <notes>
+                <para><emphasis>TODO</emphasis>: Documentation outdated.</para>
                 <para>This is a boost extension.</para>
                 <para>Behavior is undefined if the two containers don't have
                     equivalent equality predicates.</para>
diff --git a/doc/ref.xml b/doc/ref.xml
index 449121e1..14ca58db 100644
--- a/doc/ref.xml
+++ b/doc/ref.xml
@@ -842,6 +842,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
               </parameter>
               <type>bool</type>
               <notes>
+                <para><emphasis>TODO</emphasis>: Documentation outdated.</para>
                 <para>This is a boost extension.</para>
                 <para>Behavior is undefined if the two containers don't have
                     equivalent equality predicates.</para>
@@ -866,6 +867,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
               </parameter>
               <type>bool</type>
               <notes>
+                <para><emphasis>TODO</emphasis>: Documentation outdated.</para>
                 <para>This is a boost extension.</para>
                 <para>Behavior is undefined if the two containers don't have
                     equivalent equality predicates.</para>
@@ -1740,6 +1742,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
               </parameter>
               <type>bool</type>
               <notes>
+                <para><emphasis>TODO</emphasis>: Documentation outdated.</para>
                 <para>This is a boost extension.</para>
                 <para>Behavior is undefined if the two containers don't have
                     equivalent equality predicates.</para>
@@ -1764,6 +1767,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
               </parameter>
               <type>bool</type>
               <notes>
+                <para><emphasis>TODO</emphasis>: Documentation outdated.</para>
                 <para>This is a boost extension.</para>
                 <para>Behavior is undefined if the two containers don't have
                     equivalent equality predicates.</para>
@@ -2689,6 +2693,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
               </parameter>
               <type>bool</type>
               <notes>
+                <para><emphasis>TODO</emphasis>: Documentation outdated.</para>
                 <para>This is a boost extension.</para>
                 <para>Behavior is undefined if the two containers don't have
                     equivalent equality predicates.</para>
@@ -2715,6 +2720,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
               </parameter>
               <type>bool</type>
               <notes>
+                <para><emphasis>TODO</emphasis>: Documentation outdated.</para>
                 <para>This is a boost extension.</para>
                 <para>Behavior is undefined if the two containers don't have
                     equivalent equality predicates.</para>
@@ -3601,6 +3607,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
               </parameter>
               <type>bool</type>
               <notes>
+                <para><emphasis>TODO</emphasis>: Documentation outdated.</para>
                 <para>This is a boost extension.</para>
                 <para>Behavior is undefined if the two containers don't have
                     equivalent equality predicates.</para>
@@ -3627,6 +3634,7 @@ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
               </parameter>
               <type>bool</type>
               <notes>
+                <para><emphasis>TODO</emphasis>: Documentation outdated.</para>
                 <para>This is a boost extension.</para>
                 <para>Behavior is undefined if the two containers don't have
                     equivalent equality predicates.</para>