[Boost-commit] svn:boost r38878 - trunk/libs/functional/hash/doc

From: daniel_james_at_[hidden]
Date: 2007-08-23 21:16:54

Author: danieljames
Date: 2007-08-23 21:16:54 EDT (Thu, 23 Aug 2007)
New Revision: 38878
URL: http://svn.boost.org/trac/boost/changeset/38878

Log:
Merge some documentation improvements from the development branch.

Text files modified: 
   trunk/libs/functional/hash/doc/ref.xml      |     7 +++++++                                 
   trunk/libs/functional/hash/doc/thanks.qbk   |    13 ++++++-------                           
   trunk/libs/functional/hash/doc/tutorial.qbk |     2 +-                                      
   3 files changed, 14 insertions(+), 8 deletions(-)

Modified: trunk/libs/functional/hash/doc/ref.xml
==============================================================================
--- trunk/libs/functional/hash/doc/ref.xml	(original)
+++ trunk/libs/functional/hash/doc/ref.xml	2007-08-23 21:16:54 EDT (Thu, 23 Aug 2007)
@@ -370,6 +370,8 @@
         </method>
       </struct-specialization>
 
+      <free-function-group name="Support functions (Boost extension).">
+
       <!--
         boost::hash_combine
         -->
@@ -464,6 +466,10 @@
         </para></throws>
       </overloaded-function>
 
+      </free-function-group>
+
+      <free-function-group name="Overloadable hash implementation (Boost extension).">
+
       <!--
         boost::hash_value - integers
         -->
@@ -694,6 +700,7 @@
           </informaltable>
         </returns>
       </overloaded-function>
+      </free-function-group>
     </namespace>
   </header>
 </library-reference>

Modified: trunk/libs/functional/hash/doc/thanks.qbk
==============================================================================
--- trunk/libs/functional/hash/doc/thanks.qbk	(original)
+++ trunk/libs/functional/hash/doc/thanks.qbk	2007-08-23 21:16:54 EDT (Thu, 23 Aug 2007)
@@ -5,16 +5,15 @@
 
 [section:acknowledgements Acknowledgements]
 
-This library is based on the design by Peter Dimov's original design.
-
-During the initial development Joaquín M López Muñoz made many useful
-suggestions, contributed fixes.
+This library is based on the design by Peter Dimov. During the initial
+development
+Joaquín M López Muñoz made many useful suggestions and contributed fixes.
 
 The formal review was managed by Thorsten Ottosen, and the library reviewed by:
 David Abrahams, Alberto Barbati, Topher Cooper, Caleb Epstein, Dave Harris,
-Chris Jefferson, Bronek Kozicki, John Maddock, Tobias Swinger, Jaap Suter, Rob
-Stewart and Pavel Vozenilek. Since then, there have been further contributions
-from Daniel Krügler, Alexander Nasonov, 沈慧峰 and John Maddock.
+Chris Jefferson, Bronek Kozicki, John Maddock, Tobias Swinger, Jaap Suter,
+Rob Stewart and Pavel Vozenilek. Since then, further constructive criticism has
+been made by Daniel Krügler, Alexander Nasonov and 沈慧峰.
 
 The implementation of the hash function for pointers is based on suggestions
 made by Alberto Barbati and Dave Harris. Dave Harris also suggested an

Modified: trunk/libs/functional/hash/doc/tutorial.qbk
==============================================================================
--- trunk/libs/functional/hash/doc/tutorial.qbk	(original)
+++ trunk/libs/functional/hash/doc/tutorial.qbk	2007-08-23 21:16:54 EDT (Thu, 23 Aug 2007)
@@ -119,7 +119,7 @@
 Objects that are equal must generate the same hash value.
 When objects are not equal they should generate different hash values.
 In this object equality was based just on the id so the hash function
-only hash the id. If it was based on the objects name and author
+only hashes the id. If it was based on the object's name and author
 then the hash function should take them into account
 (how to do this is discussed in the next section).
 ]