[Boost-commit] svn:boost r46018 - branches/doc/libs/unordered/doc

From: daniel_james_at_[hidden]
Date: 2008-06-01 13:18:28

Author: danieljames
Date: 2008-06-01 13:18:27 EDT (Sun, 01 Jun 2008)
New Revision: 46018
URL: http://svn.boost.org/trac/boost/changeset/46018

Log:
Improved function summary tables in unordered documenations.

Text files modified: 
   branches/doc/libs/unordered/doc/buckets.qbk       |    86 +++++++++++++++++++++++---------------- 
   branches/doc/libs/unordered/doc/hash_equality.qbk |     4                                         
   2 files changed, 53 insertions(+), 37 deletions(-)

Modified: branches/doc/libs/unordered/doc/buckets.qbk
==============================================================================
--- branches/doc/libs/unordered/doc/buckets.qbk	(original)
+++ branches/doc/libs/unordered/doc/buckets.qbk	2008-06-01 13:18:27 EDT (Sun, 01 Jun 2008)
@@ -35,37 +35,53 @@
 the search slower. This is known as a collision. To keep things fast we try to
 keep collisions to a minimum.
 
-[table Methods for Accessing Buckets
-    [[Method] [Description]]
-
-    [
-        [``size_type bucket_count() const``]
-        [The number of buckets.]
-    ]
-    [
-        [``size_type max_bucket_count() const``]
-        [An upper bound on the number of buckets.]
-    ]
-    [
-        [``size_type bucket_size(size_type n) const``]
-        [The number of elements in bucket `n`.]
-    ]
-    [
-        [``size_type bucket(key_type const& k) const``]
-        [Returns the index of the bucket which would contain k]
-    ]
-    [
-        [``
-            local_iterator begin(size_type n);
-            local_iterator end(size_type n);
-            const_local_iterator begin(size_type n) const;
-            const_local_iterator end(size_type n) const;
-            const_local_iterator cbegin(size_type n) const;
-            const_local_iterator cend(size_type n) const;
-        ``]
-        [Return begin and end iterators for bucket `n`.]
-    ]
-]
+'''
+<table frame="all"><title>Methods for Accessing Buckets</title>
+  <tgroup cols="2">
+    <thead><row>
+      <entry><para>Method</para></entry>
+      <entry><para>Description</para></entry>
+    </row></thead>
+    <tbody>
+      <row>
+       <entry>'''`size_type bucket_count() const`'''</entry>
+       <entry>'''The number of buckets.'''</entry>
+      </row>
+      <row>
+        <entry>'''`size_type max_bucket_count() const`'''</entry>
+        <entry>'''An upper bound on the number of buckets.'''</entry>
+      </row>
+      <row>
+        <entry>'''`size_type bucket_size(size_type n) const`'''</entry>
+        <entry>'''The number of elements in bucket `n`.'''</entry>
+      </row>
+      <row>
+        <entry>'''`size_type bucket(key_type const& k) const`'''</entry>
+        <entry>'''Returns the index of the bucket which would contain k'''</entry>
+      </row>
+      <row>
+        <entry>'''`local_iterator begin(size_type n);`'''</entry>
+        <entry morerows='5'>'''Return begin and end iterators for bucket `n`.'''</entry>
+      </row>
+      <row>
+        <entry>'''`local_iterator end(size_type n);`'''</entry>
+      </row>
+      <row>
+        <entry>'''`const_local_iterator begin(size_type n) const;`'''</entry>
+      </row>
+      <row>
+        <entry>'''`const_local_iterator end(size_type n) const;`'''</entry>
+      </row>
+      <row>
+        <entry>'''`const_local_iterator cbegin(size_type n) const;`'''</entry>
+      </row>
+      <row>
+        <entry>'''`const_local_iterator cend(size_type n) const;`'''</entry>
+      </row>
+    </tbody>
+  </tgroup>
+</table>
+'''
 
 [h2 Controlling the number of buckets]
 
@@ -100,19 +116,19 @@
     [[Method] [Description]]
 
     [
-        [``float load_factor() const``]
+        [`float load_factor() const`]
         [The average number of elements per bucket.]
     ]
     [
-        [``float max_load_factor() const``]
+        [`float max_load_factor() const`]
         [Returns the current maximum load factor.]
     ]
     [
-        [``float max_load_factor(float z)``]
+        [`float max_load_factor(float z)`]
         [Changes the container's maximum load factor, using `z` as a hint.]
     ]
     [
-        [``void rehash(size_type n)``]
+        [`void rehash(size_type n)`]
         [Changes the number of buckets so that there at least n buckets, and
         so that the load factor is less than the maximum load factor.]
     ]

Modified: branches/doc/libs/unordered/doc/hash_equality.qbk
==============================================================================
--- branches/doc/libs/unordered/doc/hash_equality.qbk	(original)
+++ branches/doc/libs/unordered/doc/hash_equality.qbk	2008-06-01 13:18:27 EDT (Sun, 01 Jun 2008)
@@ -63,11 +63,11 @@
     [[Method] [Description]]
 
     [
-        [``hasher hash_function() const``]
+        [`hasher hash_function() const`]
         [Returns the container's hash function.]
     ]
     [
-        [``key_equal key_eq() const``]
+        [`key_equal key_eq() const`]
         [Returns the container's key equality function.]
     ]
 ]