[Boost-bugs] [Boost C++ Libraries] #9222: iostreams documentation hard to read

Subject: [Boost-bugs] [Boost C++ Libraries] #9222: iostreams documentation hard to read
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2013-10-10 10:56:26

#9222: iostreams documentation hard to read
------------------------------+---------------------------
 Reporter:  harris.pc@…       |      Owner:  matias
     Type:  Feature Requests  |     Status:  new
Milestone:  To Be Determined  |  Component:  Documentation
  Version:  Boost 1.54.0      |   Severity:  Problem
 Keywords:                    |
------------------------------+---------------------------
 Hi,

 You guys have put a lot of work into iostreams documentation,
 but,
 where it falls down is when someone unfamiliar with the library (ie, me)
 wants to quickly figure out how to do something.

 For example, I wanted to create an input stream from an existing array.

 I found this page:
 http://www.boost.org/doc/libs/1_54_0/libs/iostreams/doc/classes/array.html


 But frustratingly, there was no example on how to use.
 Google was of limited use, eventually I found this page,
 http://www.boost.org/doc/libs/1_53_0/libs/iostreams/doc/guide/generic_streams.html#examples


 Which was exactly what I wanted to know,
 but there really should be an example on the array's page, or at least a
 link to the relevant documentation that talks about how to use it.

 Was very frustrating.

 cheers,
 Paul

-- 
Ticket URL: <https://svn.boost.org/trac/boost/ticket/9222>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.