Boost C++ Libraries: Ticket #12030: boost iostreams documentation misstates filtering_streambuf typedef https://svn.boost.org/trac10/ticket/12030 <p> This report concerns iostreams documentation. </p> <p> The documentation for class template filtering_streambuf misstates the name of four typedefs: </p> <p> From the <a href="http://www.boost.org/doc/libs/1_60_0/libs/iostreams/doc/classes/filtering_streambuf.html">filtering_streambuf documentation page</a>: </p> <pre class="wiki">typedef filtering_streambuf&lt;input&gt; filtering_istream; typedef filtering_streambuf&lt;output&gt; filtering_ostream; typedef filtering_wstreambuf&lt;input&gt; filtering_wistream; typedef filtering_wstreambuf&lt;output&gt; filtering_wostream; </pre><p> This page is part of the reachable from the <a href="http://www.boost.org/doc/libs/1_60_0/libs/iostreams/doc/">Reference</a> section, under Classes. </p> <p> This conflicts with, and is probably the result of a copy-paste from, the documentation of the filtering_stream class template. From the <a href="http://www.boost.org/doc/libs/1_60_0/libs/iostreams/doc/classes/filtering_stream.html">filtering_stream documentation</a>: </p> <pre class="wiki">typedef filtering_stream&lt;input&gt; filtering_istream; typedef filtering_stream&lt;output&gt; filtering_ostream; typedef filtering_wstream&lt;input&gt; filtering_wistream; typedef filtering_wstream&lt;output&gt; filtering_wostream; </pre><p> The filtering_streambuf documentation page should be changed to match the actual typedefs in the source code, which very sensibly have the form "filtering_istreambuf", etc. From boost/1.60.0/include/boost/iostreams/filtering_streambuf.hpp: </p> <pre class="wiki">typedef filtering_streambuf&lt;input&gt; filtering_istreambuf; typedef filtering_streambuf&lt;output&gt; filtering_ostreambuf; typedef filtering_wstreambuf&lt;input&gt; filtering_wistreambuf; typedef filtering_wstreambuf&lt;output&gt; filtering_wostreambuf; </pre> en-us Boost C++ Libraries /htdocs/site/boost.png https://svn.boost.org/trac10/ticket/12030 Trac 1.4.3 Nicholas Musolino <n.musolino@…> Sun, 28 Feb 2016 16:00:13 GMT <link>https://svn.boost.org/trac10/ticket/12030#comment:1 </link> <guid isPermaLink="false">https://svn.boost.org/trac10/ticket/12030#comment:1</guid> <description> <p> Fix proposed at pull request on github: <a class="ext-link" href="https://github.com/boostorg/iostreams/pull/27"><span class="icon">​</span>Fix minor filtering_streambuf documentation error. Refs #12030</a>. </p> </description> <category>Ticket</category> </item> </channel> </rss>