[Boost-commit] svn:boost r74194 - trunk/libs/unordered/doc

Subject: [Boost-commit] svn:boost r74194 - trunk/libs/unordered/doc
From: dnljms_at_[hidden]
Date: 2011-09-02 04:29:24

Author: danieljames
Date: 2011-09-02 04:29:23 EDT (Fri, 02 Sep 2011)
New Revision: 74194
URL: http://svn.boost.org/trac/boost/changeset/74194

Log:
Unordered: Documentation changes.
Text files modified: 
   trunk/libs/unordered/doc/hash_equality.qbk |     3 ++-                                     
   trunk/libs/unordered/doc/ref.php           |     2 ++                                      
   trunk/libs/unordered/doc/ref.xml           |     8 ++++++++                                
   3 files changed, 12 insertions(+), 1 deletions(-)

Modified: trunk/libs/unordered/doc/hash_equality.qbk
==============================================================================
--- trunk/libs/unordered/doc/hash_equality.qbk	(original)
+++ trunk/libs/unordered/doc/hash_equality.qbk	2011-09-02 04:29:23 EDT (Fri, 02 Sep 2011)
@@ -67,7 +67,8 @@
 
 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]]

Modified: trunk/libs/unordered/doc/ref.php
==============================================================================
--- trunk/libs/unordered/doc/ref.php	(original)
+++ trunk/libs/unordered/doc/ref.php	2011-09-02 04:29:23 EDT (Fri, 02 Sep 2011)
@@ -962,6 +962,7 @@
               </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 @@
               </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>

Modified: trunk/libs/unordered/doc/ref.xml
==============================================================================
--- trunk/libs/unordered/doc/ref.xml	(original)
+++ trunk/libs/unordered/doc/ref.xml	2011-09-02 04:29:23 EDT (Fri, 02 Sep 2011)
@@ -842,6 +842,7 @@
               </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 @@
               </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 @@
               </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 @@
               </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 @@
               </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 @@
               </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 @@
               </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 @@
               </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>