Opened 10 years ago
Closed 9 years ago
#8460 closed Bugs (fixed)
Doc errors
Reported by: | Owned by: | Daniel James | |
---|---|---|---|
Milestone: | To Be Determined | Component: | iostreams |
Version: | Boost 1.53.0 | Severity: | Cosmetic |
Keywords: | Cc: |
Description
I'm just starting to read the Boost.Iostreams documentation and found some minor errors. Perhaps someone would like to make these trivial corrections to help other novices in the future.
(1) 2.1.4. In the implementation of container_device::write, the block that writes remaining characters at the end of the container ("if (result < n) { ... }") should insert characters from 's + result', not from 's': "container_.insert(container_.end(), s + result, s + n);".
(2) 2.1.4. In the implementation of container_device::seek, there are 3 uses of "ios_bas" instead of "ios_base".
(3) 2.1.4. c/striaghforward/straightforward
(4) Function Template tee In the Description section second paragraph, "Device" should be "Sink" (should be "given a Sink or a pair of Sinks").
Change History (8)
comment:1 by , 10 years ago
comment:2 by , 10 years ago
(6) Function Template get: In the Example, "(c == boost::iostreams::get(src))" should be "(c = boost::iostreams::get(src))". It should be an assignment, not a comparison.
comment:3 by , 10 years ago
(7) Class Template filtering_stream: The heading "filtering_stream::push" does not belong embedded in the description of the constructors. It appears just after the description of the default constructor.
comment:4 by , 9 years ago
(8) In Quick Reference: In the Core Components table, the entry for "filtering_streambuf" links to the Class Template filtering_stream page instead of filtering_streambuf.
comment:5 by , 9 years ago
(9) Class Template filtering_streambuf: There is an errant heading "filtering_streambuf::push" equivalent to error (7) above.
comment:7 by , 9 years ago
Owner: | changed from | to
---|---|
Status: | new → assigned |
(5) Function Template putback: In the Overview, "put" should be "putback".