Subject: [Boost-bugs] [Boost C++ Libraries] #12030: boost iostreams documentation misstates filtering_streambuf typedef
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2016-02-28 15:39:35
#12030: boost iostreams documentation misstates filtering_streambuf typedef
----------------------------------------------+-----------------------
Reporter: Nicholas Musolino <n.musolino@â¦> | Owner: turkanis
Type: Bugs | Status: new
Milestone: To Be Determined | Component: iostreams
Version: Boost 1.60.0 | Severity: Problem
Keywords: |
----------------------------------------------+-----------------------
This report concerns iostreams documentation.
The documentation for class template filtering_streambuf misstates the
name of four typedefs:
From the
[http://www.boost.org/doc/libs/1_60_0/libs/iostreams/doc/classes/filtering_streambuf.html
filtering_streambuf documentation page]:
{{{
typedef filtering_streambuf<input> filtering_istream;
typedef filtering_streambuf<output> filtering_ostream;
typedef filtering_wstreambuf<input> filtering_wistream;
typedef filtering_wstreambuf<output> filtering_wostream;
}}}
This page is part of the reachable from the
[http://www.boost.org/doc/libs/1_60_0/libs/iostreams/doc/ "Reference"]
section, under Classes.
This conflicts with, and is probably the result of a copy-paste from, the
documentation of the filtering_stream class template. From the
[http://www.boost.org/doc/libs/1_60_0/libs/iostreams/doc/classes/filtering_stream.html
filtering_stream documentation]:
{{{
typedef filtering_stream<input> filtering_istream;
typedef filtering_stream<output> filtering_ostream;
typedef filtering_wstream<input> filtering_wistream;
typedef filtering_wstream<output> filtering_wostream;
}}}
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:
{{{
typedef filtering_streambuf<input> filtering_istreambuf;
typedef filtering_streambuf<output> filtering_ostreambuf;
typedef filtering_wstreambuf<input> filtering_wistreambuf;
typedef filtering_wstreambuf<output> filtering_wostreambuf;
}}}
-- Ticket URL: <https://svn.boost.org/trac/boost/ticket/12030> Boost C++ Libraries <http://www.boost.org/> Boost provides free peer-reviewed portable C++ source libraries.
This archive was generated by hypermail 2.1.7 : 2017-02-16 18:50:19 UTC