Boost C++ Libraries: Ticket #10322: documentation for erase method of multisets is wrong https://svn.boost.org/trac10/ticket/10322 <p> This is a documentation bug. </p> <p> The page <a href="http://www.boost.org/doc/libs/1_56_0/doc/html/boost/intrusive/multiset.html#idp34712280-bb">here</a> states that <code>erase(const_reference value)</code> "erases the element pointed to by <code>pos</code>". First of all, this is a typo because <code>pos</code> is not an argument. One would assume that the element to be erased is the one referenced by <code>value</code>. </p> <p> It turns out that this is wrong: this overload erases not just one element (the given one), but in fact, <strong>all</strong> elements of the multiset with key equivalent to the given one (according to the container's internal comparator method). This is immediately apparent by looking at the definition of <code>erase(const_reference value)</code> inside <code>bstree.hpp</code>. </p> <p> Most likely this affects the documentation for the other multiset variants as well (avl, etc). </p> en-us Boost C++ Libraries /htdocs/site/boost.png https://svn.boost.org/trac10/ticket/10322 Trac 1.4.3 Matei David <matei@…> Fri, 08 Aug 2014 00:22:39 GMT attachment set https://svn.boost.org/trac10/ticket/10322 https://svn.boost.org/trac10/ticket/10322 <ul> <li><strong>attachment</strong> → <span class="trac-field-new">bug-erase.cpp</span> </li> </ul> <p> demonstrates the bug (compile with std=c++11) </p> Ticket Ion Gaztañaga Mon, 19 Jan 2015 22:19:49 GMT <link>https://svn.boost.org/trac10/ticket/10322#comment:1 </link> <guid isPermaLink="false">https://svn.boost.org/trac10/ticket/10322#comment:1</guid> <description> <p> It seems that we have a problem with Doxygen or <a class="missing wiki">BoostBook</a> as I can see any error in the comment and the autodoc.xml has the wrong comment. I still don't know how to fix this without duplicating comments, something that I'd like to avoid. Thanks for the report. </p> </description> <category>Ticket</category> </item> <item> <dc:creator>Steven Watanabe</dc:creator> <pubDate>Sun, 01 Mar 2015 04:31:47 GMT</pubDate> <title/> <link>https://svn.boost.org/trac10/ticket/10322#comment:2 </link> <guid isPermaLink="false">https://svn.boost.org/trac10/ticket/10322#comment:2</guid> <description> <p> BoostBook + Doxygen can't handle multiple overloads very well. The best way that I've found is to put all the documentation on the first overload and then mark the rest with \overload. </p> </description> <category>Ticket</category> </item> </channel> </rss>