Menu
▾
▴
boost-sandbox-cvs
|
From: Jan G. <jan...@us...> - 2007-04-09 22:06:17
|
Update of /cvsroot/boost-sandbox/boost-sandbox/libs/circular_buffer/doc In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv2309/libs/circular_buffer/doc Modified Files: circular_buffer.html circular_buffer_space_optimized.html circular_buffer_space_optimized.xslt Log Message: circular_buffer: updated srcdoc and test cases Index: circular_buffer.html =================================================================== RCS file: /cvsroot/boost-sandbox/boost-sandbox/libs/circular_buffer/doc/circular_buffer.html,v retrieving revision 1.63 retrieving revision 1.64 diff -u -d -r1.63 -r1.64 --- circular_buffer.html 8 Apr 2007 22:10:24 -0000 1.63 +++ circular_buffer.html 9 Apr 2007 22:06:13 -0000 1.64 @@ -1000,6 +1000,16 @@ Create an empty <code>circular_buffer</code> with the specified capacity. <dl> <dt> + <b>Effect:</b> + </dt> + <dd> + <code><a href="#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> == + capacity && <a href= + "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a> == 0</code> + </dd> + </dl> + <dl> + <dt> <b>Parameter(s):</b> </dt> <dd> @@ -1025,16 +1035,6 @@ </dl> <dl> <dt> - <b>Effect:</b> - </dt> - <dd> - <code><a href="#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> == - capacity && <a href= - "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a> == 0</code> - </dd> - </dl> - <dl> - <dt> <b>Throws:</b> </dt> <dd> @@ -1069,9 +1069,9 @@ </dt> <dd> <code><a href="#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> == n - && <a href="#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a> == n - && (*this)[0] == item && (*this)[1] == item && ... && (*this) [n - 1] - == item</code> + && <a href="#classboost_1_1circular__buffer_1fd0eef8ba91210d1575404b7e3e8207a">full()</a> + && (*this)[0] == item && (*this)[1] == item && ... && (*this)[n - 1] == + item</code> </dd> </dl> <dl> @@ -1294,7 +1294,7 @@ "#classboost_1_1circular__buffer_14e07c6ddfe89debe384e59bed06e7cb7">allocator_type</a>& alloc = allocator_type());</b></code><br> <br> - Create a <code>circular_buffer</code> filled with a copy of the range. + Create a full <code>circular_buffer</code> filled with a copy of the range. <dl> <dt> <b>Precondition:</b> @@ -1312,9 +1312,9 @@ <dd> <code><a href="#classboost_1_1circular__buffer_15ebab2b2538d733790b5752582728e77">capacity()</a> == std::distance(first, last) && <a href= - "#classboost_1_1circular__buffer_15fa0edd153e2591dd6bf070eb663ee32">size()</a> == std::distance(first, - last) && (*this)[0]== *first && (*this)[1] == *(first + 1) && ... && - (*this)[std::distance(first, last) - 1] == *(last - 1)</code> + "#classboost_1_1circular__buffer_1fd0eef8ba91210d1575404b7e3e8207a">full()</a> && (*this)[0]== + *first && (*this)[1] == *(first + 1) && ... && (*this)[std::distance(first, + last) - 1] == *(last - 1)</code> </dd> </dl> <dl> @@ -3670,7 +3670,7 @@ </dt> <dd> The element the <code>circular_buffer</code> will be filled with in order to gain the requested - size. (See the postcondition.) + size. (See the <i>Effect</i>.) </dd> </dl> </dd> @@ -6781,7 +6781,7 @@ <p> <small>Use, modification, and distribution is subject to the Boost Software License, Version 1.0.<br> (See accompanying file <code>LICENSE_1_0.txt</code> or copy at <a href= - "http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>.)</small> + "http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</small> </p> </td> <td valign="top" align="right"> Index: circular_buffer_space_optimized.xslt =================================================================== RCS file: /cvsroot/boost-sandbox/boost-sandbox/libs/circular_buffer/doc/circular_buffer_space_optimized.xslt,v retrieving revision 1.20 retrieving revision 1.21 diff -u -d -r1.20 -r1.21 --- circular_buffer_space_optimized.xslt 8 Apr 2007 22:10:24 -0000 1.20 +++ circular_buffer_space_optimized.xslt 9 Apr 2007 22:06:14 -0000 1.21 @@ -23,7 +23,7 @@ <xsl:variable name="standalone-functions" select="document(concat($xmldir, '/namespaceboost.xml'))/doxygen/compounddef/sectiondef[@kind='func']"/> <xsl:template name="reference"> - <xsl:variable name="refid" select="$circular_buffer-reimplemented[@refid=current()/@refid]/../@id"/> + <xsl:variable name="refid" select="$circular_buffer-reimplemented[@refid=current()/@refid and text()!='capacity_type']/../@id"/> <xsl:value-of select="concat(substring(concat($link-prefix, '#', $refid), 1 div (string-length($refid) > 0)), substring(concat('#', @refid), 1 div (string-length($refid) = 0)))"/> </xsl:template> @@ -71,30 +71,6 @@ <xsl:for-each select="$current[string-length(normalize-space(briefdescription)) > 0]"> <xsl:apply-templates select="." mode="synopsis"/> </xsl:for-each> - <!-- - <xsl:for-each select="$current | document($circular_buffer-file)/doxygen/compounddef[@id = $circular_buffer-ref and @kind = 'class']/sectiondef[@kind='public-func']/memberdef[type != '']"> - <xsl:variable name="briefdescription" select="normalize-space(briefdescription)"/> - <xsl:if test="string-length($briefdescription) > 0"> - <xsl:choose> - <xsl:when test="count($current[name=current()/name]) > 0 and count(param/type[ref='circular_buffer']) > 0"> - <xsl:apply-templates select="$current[name=current()/name]" mode="synopsis"> - <xsl:with-param name="link-prefix" select="$link-prefix"/> - <xsl:with-param name="link" select="@id"/> - </xsl:apply-templates> - </xsl:when> - <xsl:when test="count($current[name=current()/name]) > 0 and count(param/type[ref='circular_buffer_space_optimized']) > 0"/> - <xsl:when test="../../compoundname = 'boost::circular_buffer_space_optimized'"> - <xsl:apply-templates select="." mode="synopsis"/> - </xsl:when> - <xsl:otherwise> - <xsl:apply-templates select="." mode="synopsis"> - <xsl:with-param name="link-prefix" select="$link-prefix"/> - </xsl:apply-templates> - </xsl:otherwise> - </xsl:choose> - </xsl:if> - </xsl:for-each> - --> </xsl:template> <xsl:template name="standalone-functions"> Index: circular_buffer_space_optimized.html =================================================================== RCS file: /cvsroot/boost-sandbox/boost-sandbox/libs/circular_buffer/doc/circular_buffer_space_optimized.html,v retrieving revision 1.37 retrieving revision 1.38 diff -u -d -r1.37 -r1.38 --- circular_buffer_space_optimized.html 8 Apr 2007 22:10:24 -0000 1.37 +++ circular_buffer_space_optimized.html 9 Apr 2007 22:06:14 -0000 1.38 @@ -190,11 +190,11 @@ const capacity_type& <a href= "#classboost_1_1circular__buffer__space__optimized_1aa2695c84ac9fc912e28d1a5920dadfa">capacity</a>() const; void <a href= -"#classboost_1_1circular__buffer__space__optimized_143fa35280fc3cad2a6510065a065d67c">set_capacity</a>(const capacity_type& new_capacity); +"#classboost_1_1circular__buffer__space__optimized_149f28bc5b33d2062b9f6a33b48264e3f">set_capacity</a>(const capacity_type& capacity_ctrl); void <a href= "#classboost_1_1circular__buffer__space__optimized_1f244ff5576b79f8d60e273c02d71c9f2">resize</a>(size_type new_size, const_reference item = value_type()); void <a href= -"#classboost_1_1circular__buffer__space__optimized_16e2c5d77ea32819fd28f8ff2d5ce888a">rset_capacity</a>(size_type new_capacity); +"#classboost_1_1circular__buffer__space__optimized_10f096c108ebde69ae83a9de41b3bea56">rset_capacity</a>(const capacity_type& capacity_ctrl); void <a href= [...1363 lines suppressed...] </tr> <tr> @@ -877,7 +1646,7 @@ <a id="classboost_1_1circular__buffer__space__optimized_1108055ae3f6b1635e1428b0455902cbf" name= "classboost_1_1circular__buffer__space__optimized_1108055ae3f6b1635e1428b0455902cbf"></a><code><b>void assign(<a href= - "circular_buffer.html#classboost_1_1circular__buffer_1dc642ff2be4db0be1a457810e5d09595">capacity_type</a> + "#classboost_1_1circular__buffer__space__optimized_1e805212e7de49dcb60f2cad1ef304bb3">capacity_type</a> capacity_ctrl, <a href= "circular_buffer.html#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> n, <a href= @@ -907,7 +1676,7 @@ "classboost_1_1circular__buffer__space__optimized_1e9347091d2d644854af0821d4b46869b"></a> <code><b>template <class InputIterator><br> void assign(<a href= - "circular_buffer.html#classboost_1_1circular__buffer_1dc642ff2be4db0be1a457810e5d09595">capacity_type</a> + "#classboost_1_1circular__buffer__space__optimized_1e805212e7de49dcb60f2cad1ef304bb3">capacity_type</a> capacity_ctrl, InputIterator first, InputIterator last);</b></code><br> <br> See the <a href="circular_buffer.html#classboost_1_1circular__buffer">circular_buffer</a> source |
Thanks for helping keep SourceForge clean.
X