Update of /cvsroot/boost/boost/boost/circular_buffer
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv19298
Modified Files:
space_optimized.hpp
Log Message:
circuler_buffer: applied boost documentation style
Index: space_optimized.hpp
===================================================================
RCS file: /cvsroot/boost/boost/boost/circular_buffer/space_optimized.hpp,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- space_optimized.hpp 10 Jun 2007 22:01:53 -0000 1.6
+++ space_optimized.hpp 1 Jul 2007 09:13:20 -0000 1.7
@@ -65,14 +65,14 @@
operator size_type() const { return m_capacity; }
};</pre></p>
\pre <code>capacity >= min_capacity</code>
- <p>The <code>m_capacity</code> represents the capacity of the
<code>circular_buffer_space_optimized</code> and
- the <code>m_min_capacity</code> determines the minimal allocated size
of its internal buffer.</p>
+ <p>The <code>capacity()</code> represents the capacity of the
<code>circular_buffer_space_optimized</code> and
+ the <code>min_capacity()</code> determines the minimal allocated size
of its internal buffer.</p>
<p>The converting constructor of the <code>capacity_control</code>
allows implicit conversion from
<code>size_type</code>-like types which ensures compatibility of
creating an instance of the
<code>circular_buffer_space_optimized</code> with other STL
containers. On the other hand the operator
- <code>%size_type()</code> (returning <code>m_capacity</code>) provides
implicit conversion to the
- <code>size_type</code> which allows to treat the capacity of the
<code>circular_buffer_space_optimized</code>
- the same way as in the <code><a
href="circular_buffer.html">circular_buffer</a></code>.</p>
+ <code>%size_type()</code> provides implicit conversion to the
<code>size_type</code> which allows to treat the
+ capacity of the <code>circular_buffer_space_optimized</code> the same
way as in the
+ <code><a href="circular_buffer.html">circular_buffer</a></code>.</p>
*/
typedef cb_details::capacity_control<size_type> capacity_type;
-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
_______________________________________________
Boost-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/boost-cvs
