boost iostreams documentation misstates filtering_streambuf typedef

[Nicholas Musolino <n.musolino@…>]

This report concerns iostreams documentation.

The documentation for class template filtering_streambuf misstates the name of four typedefs:

From the 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 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 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;

[Nicholas Musolino <n.musolino@…>]

Fix proposed at pull request on github: ​Fix minor filtering_streambuf documentation error. Refs #12030.