|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r72616 - in sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html: reference style
From: cpp.cabrera_at_[hidden]
Date: 2011-06-16 15:59:56
Author: alejandro
Date: 2011-06-16 15:59:54 EDT (Thu, 16 Jun 2011)
New Revision: 72616
URL: http://svn.boost.org/trac/boost/changeset/72616
Log:
Added CSS rules to style function reference blocks. Added table of contents for function reference, tinkering with styles for function reference blocks.
Text files modified:
sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/reference/bloom.html | 144 +++++++++++++++++++++++++++++++++++++--
sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/style/my.css | 13 +++
2 files changed, 149 insertions(+), 8 deletions(-)
Modified: sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/reference/bloom.html
==============================================================================
--- sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/reference/bloom.html (original)
+++ sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/reference/bloom.html 2011-06-16 15:59:54 EDT (Thu, 16 Jun 2011)
@@ -90,19 +90,147 @@
<dt>T</dt>
<dd>The type used for all Bloom filter operations.</dd>
<dt>Size</dt>
- <dd>The size in bits of the underlying bitset used by the Bloom filter.</dd>
+ <dd>The size in bits of the underlying std::bitset used by the Bloom filter.</dd>
<dt>HashFunctions</dt>
- <dd>The set of hash functions used by the Bloom filter. Currently required to be an mpl::vector of Hashers.</dd>
+ <dd>The set of hash functions used by the Bloom filter. Currently required to be an mpl::vector of Hashers.</dd>
</dl>
- <h2>Function Reference</h2>
- <h5>Function name</h5>
- <p>Description text</p>
- <h6>Pre-condition</h6>
- <h6>Post-condition</h6>
- <h6>Returns</h6>
+ <div class="toc">
+ <p>Function Reference</p>
+ <ul>
+ <li>bloom_filter()</li>
+ <li>size()</li>
+ <li>num_hash_functions()</li>
+ <li>count()</li>
+ <li>insert()</li>
+ <li>contains()</li>
+ <li>operator|=()</li>
+ <li>operator&=()</li>
+ <li>operator|()</li>
+ <li>operator&()</li>
+ </ul>
+ </div>
+
+ <br/>
+
+ <h1>WIP BELOW THIS POINT</h1>
+
+ <div class="func_ref">
+ <a name="constructor"></a>
+ <h3><code class="c_func">bloom_filter</code>()</h3>
+ <dl>
+ <dt>Description</dt>
+ <dd>Constructs a bloom_filter object with all bits set to 0.</dd>
+ </dl>
+ </div>
+
+ <div class="func_ref">
+ <a name="size"></a>
+ <h3><code class="c_func">size</code>()</h3>
+ <dl>
+ <dt>Description</dt>
+ <dd>Returns the number of bits used internally by the Bloom filter..</dd>
+ <dt>Returns</dt>
+ <dd>Value of template parameter Size.</dd>
+ </dl>
+ </div>
+
+
+ <div class="func_ref">
+ <a name="num_hash_functions"></a>
+ <h3><code class="c_func">num_hash_functions</code>()</h3>
+ <dl>
+ <dt>Description</dt>
+ <dd>Returns the number of bits used internally by the Bloom filter..</dd>
+ <dt>Returns</dt>
+ <dd>Value of template parameter Size.</dd>
+ </dl>
+ </div>
+
+ <div class="func_ref">
+ <a name="count"></a>
+ <h3><code class="c_func">count</code>()</h3>
+ <dl>
+ <dt>Description</dt>
+ <dd>Returns the number of bits used internally by the Bloom filter..</dd>
+ <dt>Returns</dt>
+ <dd>Value of template parameter Size.</dd>
+ </dl>
+ </div>
+
+
+ <div class="func_ref">
+ <a name="insert"></a>
+ <h3><code class="c_func">insert</code>()</h3>
+ <dl>
+ <dt>Description</dt>
+ <dd>Returns the number of bits used internally by the Bloom filter..</dd>
+ <dt>Returns</dt>
+ <dd>Value of template parameter Insert.</dd>
+ </dl>
+ </div>
+
+ <div class="func_ref">
+ <a name="contains"></a>
+ <h3><code class="c_func">contains</code>()</h3>
+ <dl>
+ <dt>Description</dt>
+ <dd>Returns the number of bits used internally by the Bloom filter..</dd>
+ <dt>Returns</dt>
+ <dd>Value of template parameter Contains.</dd>
+ </dl>
+ </div>
+
+
+ <div class="func_ref">
+ <a name="union_assign"></a>
+ <h3><code class="c_func">operator|=</code>()</h3>
+ <dl>
+ <dt>Description</dt>
+ <dd>Returns the number of bits used internally by the Bloom filter..</dd>
+ <dt>Returns</dt>
+ <dd>Value of template parameter Union_Assign.</dd>
+ </dl>
+ </div>
+
+ <div class="func_ref">
+ <a name="intersect_assign"></a>
+ <h3><code class="c_func">operator&=</code>()</h3>
+ <dl>
+ <dt>Description</dt>
+ <dd>Returns the number of bits used internally by the Bloom filter..</dd>
+ <dt>Returns</dt>
+ <dd>Value of template parameter Size.</dd>
+ </dl>
+ </div>
+
+
+ <div class="func_ref">
+ <a name="union"></a>
+ <h3><code class="c_func">operator|</code>()</h3>
+ <dl>
+ <dt>Description</dt>
+ <dd>Returns the number of bits used internally by the Bloom filter..</dd>
+ <dt>Returns</dt>
+ <dd>Value of template parameter Union_Assign.</dd>
+ </dl>
+ </div>
+
+
+ <div class="func_ref">
+ <a name="intersect"></a>
+ <h3><code class="c_func">operator&</code>()</h3>
+ <dl>
+ <dt>Description</dt>
+ <dd>Returns the number of bits used internally by the Bloom filter..</dd>
+ <dt>Returns</dt>
+ <dd>Value of template parameter Size.</dd>
+ </dl>
+ </div>
+
<hr/>
+
<div class="spirit-nav">
<a accesskey="p" href="../reference.html">
<img src="../../../../../doc/src/images/prev.png" alt="Prev"/>
Modified: sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/style/my.css
==============================================================================
--- sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/style/my.css (original)
+++ sandbox/bloom_filter/trunk/libs/bloom_filter/doc/html/style/my.css 2011-06-16 15:59:54 EDT (Thu, 16 Jun 2011)
@@ -14,6 +14,10 @@
.toc p {font-weight: bold;}
.copyright {font-style: italic;}
+dt {
+ font-weight: bold;
+};
+
header {
height: 94px;
position: relative;
@@ -46,6 +50,15 @@
margin-right: 5%;
}
+.func_ref {
+ background: #f0f0f0;
+ display: block;
+ margin-bottom: 1%;
+ margin-left: 1%;
+ margin-right: 1%;
+ border: solid 1px;
+}
+
.example_output {
white-space: pre;
background: #000000;
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk