|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r84161 - in trunk/libs/iostreams/doc: . classes functions tutorial
From: dnljms_at_[hidden]
Date: 2013-05-06 05:16:02
Author: danieljames
Date: 2013-05-06 05:16:01 EDT (Mon, 06 May 2013)
New Revision: 84161
URL: http://svn.boost.org/trac/boost/changeset/84161
Log:
Fix iostream doc errors. Refs #8460
Text files modified:
trunk/libs/iostreams/doc/classes/filtering_stream.html | 15 +++++----------
trunk/libs/iostreams/doc/classes/filtering_streambuf.html | 17 ++++++-----------
trunk/libs/iostreams/doc/functions/get.html | 4 ++--
trunk/libs/iostreams/doc/functions/putback.html | 4 ++--
trunk/libs/iostreams/doc/functions/tee.html | 2 +-
trunk/libs/iostreams/doc/quick_reference.html | 10 +++++-----
trunk/libs/iostreams/doc/tutorial/container_device.html | 16 ++++++++--------
7 files changed, 29 insertions(+), 39 deletions(-)
Modified: trunk/libs/iostreams/doc/classes/filtering_stream.html
==============================================================================
--- trunk/libs/iostreams/doc/classes/filtering_stream.html (original)
+++ trunk/libs/iostreams/doc/classes/filtering_stream.html 2013-05-06 05:16:01 EDT (Mon, 06 May 2013)
@@ -133,7 +133,6 @@
<H4>Template parameters</H4>
<TABLE STYLE="margin-left:2em" BORDER=0 CELLPADDING=2>
-<TR>
<TR>
<TD VALIGN="top"><I>Mode</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
<TD>A mode tag.</TD>
@@ -166,7 +165,7 @@
</P>
<A NAME="policy_ctor"></A>
-<H4><CODE>filtering_stream::push</CODE></H4>
+<H4><CODE>filtering_stream::filtering_stream</CODE></H4>
<PRE CLASS="broken_ie"> <SPAN CLASS="keyword">template</SPAN><<SPAN CLASS="keyword">typename</SPAN> T>
filtering_stream( <SPAN CLASS="keyword">const</SPAN> T& t,
std::streamsize buffer_size,
@@ -176,7 +175,6 @@
</P>
<TABLE STYLE="margin-left:2em" BORDER=0 CELLPADDING=2 ID="Table1">
-<TR>
<TR>
<TD VALIGN="top"><I>T</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
<TD>A CopyConstructible model of one of the Filter or Device concepts whose character type is Ch and whose mode refines Mode</TD>
@@ -191,7 +189,7 @@
</TR>
<TR>
<TD VALIGN="top"><I>pback_size</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
- <TD>The size of the putback buffer, relevant only if <CODE>Mode</CODE> is a refinement of <A HREF="../guide/modes.html#input"><CODE>input</CODE></TD>
+ <TD>The size of the putback buffer, relevant only if <CODE>Mode</CODE> is a refinement of input</TD>
</TR>
</TABLE>
@@ -217,7 +215,6 @@
</P>
<TABLE STYLE="margin-left:2em" BORDER=0 CELLPADDING=2 ID="Table2">
-<TR>
<TR>
<TD VALIGN="top"><I>StreamOrStreambuffer</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
<TD>A standard stream or stream buffer type whose character type is Ch and whose mode refines Mode</TD>
@@ -228,7 +225,7 @@
</TR>
<TR>
<TD VALIGN="top"><I>pback_size</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
- <TD>The size of the putback buffer, relevant only if <CODE>Mode</CODE> is a refinement of <A HREF="../guide/modes.html#input"><CODE>input</CODE></TD>
+ <TD>The size of the putback buffer, relevant only if <CODE>Mode</CODE> is a refinement of input</TD>
</TR>
</TABLE>
@@ -296,7 +293,6 @@
</P>
<TABLE STYLE="margin-left:2em" BORDER=0 CELLPADDING=2 ID="Table3">
-<TR>
<TR>
<TD VALIGN="top"><I>T</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
<TD>A CopyConstructible model of one of the Filter or Device concepts whose character type is Ch and whose mode refines Mode</TD>
@@ -311,7 +307,7 @@
</TR>
<TR>
<TD VALIGN="top"><I>pback_size</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
- <TD>The size of the putback buffer, relevant only if <CODE>Mode</CODE> is a refinement of <A HREF="../guide/modes.html#input"><CODE>input</CODE></TD>
+ <TD>The size of the putback buffer, relevant only if <CODE>Mode</CODE> is a refinement of input</TD>
</TR>
</TABLE>
@@ -337,7 +333,6 @@
</P>
<TABLE STYLE="margin-left:2em" BORDER=0 CELLPADDING=2 ID="Table4">
-<TR>
<TR>
<TD VALIGN="top"><I>StreamOrStreambuffer</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
<TD>A standard stream or stream buffer type whose character type is Ch and whose mode refines Mode</TD>
@@ -348,7 +343,7 @@
</TR>
<TR>
<TD VALIGN="top"><I>pback_size</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
- <TD>The size of the putback buffer, relevant only if <CODE>Mode</CODE> is a refinement of <A HREF="../guide/modes.html#input"><CODE>input</CODE></TD>
+ <TD>The size of the putback buffer, relevant only if <CODE>Mode</CODE> is a refinement of input</TD>
</TR>
</TABLE>
Modified: trunk/libs/iostreams/doc/classes/filtering_streambuf.html
==============================================================================
--- trunk/libs/iostreams/doc/classes/filtering_streambuf.html (original)
+++ trunk/libs/iostreams/doc/classes/filtering_streambuf.html 2013-05-06 05:16:01 EDT (Mon, 06 May 2013)
@@ -129,7 +129,6 @@
<H4>Template parameters</H4>
<TABLE STYLE="margin-left:2em" BORDER=0 CELLPADDING=2>
-<TR>
<TR>
<TD VALIGN="top"><I>Mode</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
<TD>A mode tag.</TD>
@@ -148,7 +147,7 @@
</TR>
<TR>
<TD VALIGN="top"><I>Access</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
- <TD>One of <CODE>public_</CODE> or <CODE>protected_</CODE>, indicating the level of access of the chain interface. Used to hide the chain interface when defining a derived class of <CODE>filtering_streambuf</CODE></TD>
+ <TD>One of <CODE>public_</CODE> or <CODE>protected_</CODE>, indicating the level of access of the chain interface. Used to hide the chain interface when defining a derived class of <CODE>filtering_streambuf</CODE></A></TD>
</TR>
</TABLE>
@@ -162,7 +161,7 @@
</P>
<A NAME="policy_ctor"></A>
-<H4><CODE>filtering_streambuf::push</CODE></H4>
+<H4><CODE>filtering_streambuf::filtering_streambuf</CODE></H4>
<PRE CLASS="broken_ie"> <SPAN CLASS="keyword">template</SPAN><<SPAN CLASS="keyword">typename</SPAN> T>
filtering_streambuf( <SPAN CLASS="keyword">const</SPAN> T& t,
std::streamsize buffer_size,
@@ -172,7 +171,6 @@
</P>
<TABLE STYLE="margin-left:2em" BORDER=0 CELLPADDING=2 ID="Table1">
-<TR>
<TR>
<TD VALIGN="top"><I>T</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
<TD>A CopyConstructible model of one of the Filter or Device concepts whose character type is Ch and whose mode refines Mode</TD>
@@ -187,7 +185,7 @@
</TR>
<TR>
<TD VALIGN="top"><I>pback_size</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
- <TD>The size of the putback buffer, relevant only if <CODE>Mode</CODE> is a refinement of <A HREF="../guide/modes.html#input"><CODE>input</CODE></TD>
+ <TD>The size of the putback buffer, relevant only if <CODE>Mode</CODE> is a refinement of input</TD>
</TR>
</TABLE>
@@ -213,7 +211,6 @@
</P>
<TABLE STYLE="margin-left:2em" BORDER=0 CELLPADDING=2 ID="Table2">
-<TR>
<TR>
<TD VALIGN="top"><I>StreamOrStreambuffer</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
<TD>A standard stream or stream buffer type whose character type is Ch and whose mode refines Mode</TD>
@@ -224,7 +221,7 @@
</TR>
<TR>
<TD VALIGN="top"><I>pback_size</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
- <TD>The size of the putback buffer, relevant only if <CODE>Mode</CODE> is a refinement of <A HREF="../guide/modes.html#input"><CODE>input</CODE></TD>
+ <TD>The size of the putback buffer, relevant only if <CODE>Mode</CODE> is a refinement of input</TD>
</TR>
</TABLE>
@@ -292,7 +289,6 @@
</P>
<TABLE STYLE="margin-left:2em" BORDER=0 CELLPADDING=2 ID="Table3">
-<TR>
<TR>
<TD VALIGN="top"><I>T</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
<TD>A CopyConstructible model of one of the Filter or Device concepts whose character type is Ch and whose mode refines Mode</TD>
@@ -307,7 +303,7 @@
</TR>
<TR>
<TD VALIGN="top"><I>pback_size</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
- <TD>The size of the putback buffer, relevant only if <CODE>Mode</CODE> is a refinement of <A HREF="../guide/modes.html#input"><CODE>input</CODE></TD>
+ <TD>The size of the putback buffer, relevant only if <CODE>Mode</CODE> is a refinement of input</TD>
</TR>
</TABLE>
@@ -333,7 +329,6 @@
</P>
<TABLE STYLE="margin-left:2em" BORDER=0 CELLPADDING=2 ID="Table4">
-<TR>
<TR>
<TD VALIGN="top"><I>StreamOrStreambuffer</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
<TD>A standard stream or stream buffer type whose character type is Ch and whose mode refines Mode</TD>
@@ -344,7 +339,7 @@
</TR>
<TR>
<TD VALIGN="top"><I>pback_size</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
- <TD>The size of the putback buffer, relevant only if <CODE>Mode</CODE> is a refinement of <A HREF="../guide/modes.html#input"><CODE>input</CODE></TD>
+ <TD>The size of the putback buffer, relevant only if <CODE>Mode</CODE> is a refinement of input</TD>
</TR>
</TABLE>
Modified: trunk/libs/iostreams/doc/functions/get.html
==============================================================================
--- trunk/libs/iostreams/doc/functions/get.html (original)
+++ trunk/libs/iostreams/doc/functions/get.html 2013-05-06 05:16:01 EDT (Mon, 06 May 2013)
@@ -47,7 +47,7 @@
<SPAN CLASS="keyword">int</SPAN> get(Source& src)
{
<SPAN CLASS="keyword">int</SPAN> c;
- <SPAN CLASS="keyword">return</SPAN> (c == boost::iostreams::get(src)) != <SPAN CLASS='numeric_literal'>EOF</SPAN> &&
+ <SPAN CLASS="keyword">return</SPAN> (c = boost::iostreams::get(src)) != <SPAN CLASS='numeric_literal'>EOF</SPAN> &&
c != WOULD_BLOCK
?
tolower((<SPAN CLASS="keyword">unsigned</SPAN> <SPAN CLASS="keyword">char</SPAN>) c) :
@@ -146,4 +146,4 @@
<!-- End Footer -->
-</BODY>
\ No newline at end of file
+</BODY>
Modified: trunk/libs/iostreams/doc/functions/putback.html
==============================================================================
--- trunk/libs/iostreams/doc/functions/putback.html (original)
+++ trunk/libs/iostreams/doc/functions/putback.html 2013-05-06 05:16:01 EDT (Mon, 06 May 2013)
@@ -24,7 +24,7 @@
<H2>Overview</H2>
<P>
- The function template <CODE>put</CODE> provides a uniform interface for putting back characters read from models of Peekable, for use in the definitions of Filters.
+ The function template <CODE>putback</CODE> provides a uniform interface for putting back characters read from models of Peekable, for use in the definitions of Filters.
</P>
<A NAME="headers"></A>
@@ -100,4 +100,4 @@
<!-- End Footer -->
-</BODY>
\ No newline at end of file
+</BODY>
Modified: trunk/libs/iostreams/doc/functions/tee.html
==============================================================================
--- trunk/libs/iostreams/doc/functions/tee.html (original)
+++ trunk/libs/iostreams/doc/functions/tee.html 2013-05-06 05:16:01 EDT (Mon, 06 May 2013)
@@ -30,7 +30,7 @@
</P>
<P>
- The overloaded function template <A HREF='#tee'><CODE>tee</CODE></A> is an <A HREF='http://www.boost.org/more/generic_programming.html#object_generator' TARGET='_top'>object generator</A> which given a Device or a pair of Sinks returns an appropriate specialization of <CODE>tee_filter</CODE> or <CODE>tee_device</CODE>.
+ The overloaded function template <A HREF='#tee'><CODE>tee</CODE></A> is an <A HREF='http://www.boost.org/more/generic_programming.html#object_generator' TARGET='_top'>object generator</A> which given a Sink or a pair of Sinks returns an appropriate specialization of <CODE>tee_filter</CODE> or <CODE>tee_device</CODE>.
</P>
<A NAME="headers"></A>
Modified: trunk/libs/iostreams/doc/quick_reference.html
==============================================================================
--- trunk/libs/iostreams/doc/quick_reference.html (original)
+++ trunk/libs/iostreams/doc/quick_reference.html 2013-05-06 05:16:01 EDT (Mon, 06 May 2013)
@@ -4,11 +4,11 @@
<TITLE>Iostreams Quick Reference</TITLE>
<LINK REL="stylesheet" HREF="../../../boost.css">
<LINK REL="stylesheet" HREF="theme/iostreams.css">
-</HEAD>
<STYLE>
DT A { /*text-decoration:none*/ }
LI A { /*text-decoration:none;*/ font: 80% Verdana, Tahoma, Arial, Helvetica, sans-serif }
</STYLE>
+</HEAD>
<BODY>
<!-- Begin Banner -->
@@ -63,7 +63,7 @@
</TD>
</TR>
<TR>
- <TD>filtering_streambuf</TD>
+ <TD>filtering_streambuf</TD>
<TD>filtering_streambuf.hpp</TD>
<TD>
Stream buffer template which performs filtered i/o using a contained chain.
@@ -332,8 +332,8 @@
<H2>Views</H2>
<P>
- Each view consists of one or more class templates together with an object generator. <I>See</I> Views.
-<P>
+ Each view consists of one or more class templates together with an object generator. <I>See</I> Views.
+</P>
<TABLE STYLE="margin-bottom:1em" BORDER="1" CELLPADDING="6" CELLSPACING="1">
<TR>
@@ -420,4 +420,4 @@
<!-- End Footer -->
-</BODY>
\ No newline at end of file
+</BODY>
Modified: trunk/libs/iostreams/doc/tutorial/container_device.html
==============================================================================
--- trunk/libs/iostreams/doc/tutorial/container_device.html (original)
+++ trunk/libs/iostreams/doc/tutorial/container_device.html 2013-05-06 05:16:01 EDT (Mon, 06 May 2013)
@@ -136,7 +136,7 @@
pos_ += result;
}
<SPAN CLASS="keyword">if</SPAN> (result < n) {
- container_.insert(container_.end(), s, s + n);
+ container_.insert(container_.end(), s + result, s + n);
pos_ = container_.size();
}
<SPAN CLASS="keyword">return</SPAN> n;
@@ -147,11 +147,11 @@
<SPAN CLASS='comment'>// Determine new value of pos_</SPAN>
stream_offset next;
- <SPAN CLASS="keyword">if</SPAN> (way == ios_bas::beg) {
+ <SPAN CLASS="keyword">if</SPAN> (way == ios_base::beg) {
next = off;
- } <SPAN CLASS="keyword">else</SPAN> <SPAN CLASS="keyword">if</SPAN> (way == ios_bas::cur) {
+ } <SPAN CLASS="keyword">else</SPAN> <SPAN CLASS="keyword">if</SPAN> (way == ios_base::cur) {
next = pos_ + off;
- } <SPAN CLASS="keyword">else</SPAN> <SPAN CLASS="keyword">if</SPAN> (way == ios_bas::end) {
+ } <SPAN CLASS="keyword">else</SPAN> <SPAN CLASS="keyword">if</SPAN> (way == ios_base::end) {
next = container_.size() + off - <SPAN CLASS='numeric_literal'>1</SPAN>;
} <SPAN CLASS="keyword">else</SPAN> {
<SPAN CLASS="keyword">throw</SPAN> ios_base::failure(<SPAN CLASS='numeric_literal'>"bad seek direction"</SPAN>);
@@ -176,15 +176,15 @@
<P>Here, note that</P>
<UL>
-<LI>The member type <CODE>char_type</CODE> is defined to be equal to the containers's <CODE>value_type</CODE>;
+<LI>The member type <CODE>char_type</CODE> is defined to be equal to the container's <CODE>value_type</CODE>;
<LI>The member type <CODE>category</CODE> tells the Iostreams library that <CODE>container_device</CODE> is a model of SeekableDevice;
<LI>A <CODE>container_device</CODE> can be constructed from a instance of <CODE>Container</CODE>, which is passed and stored by reference, and accessible <I>via</I> the member function <CODE>container()</CODE>;
<LI>The implementation of <CODE>read</CODE> is identical to the implementation in container_source.
</UL>
-<P>The implementation of <CODE>write</CODE> is a bit different from the implementation in container_sink. Rather than simply appending characters to the container, you first check whether the current character position is somewhere in the middle of the container. If it is, you attempt to satisfy the write request by overwriting existing characters in the conatiner, starting at the current character position. If you reach the end of the container before the write request is satisfied, you insert the remaining characters at the end.</P>
+<P>The implementation of <CODE>write</CODE> is a bit different from the implementation in container_sink. Rather than simply appending characters to the container, you first check whether the current character position is somewhere in the middle of the container. If it is, you attempt to satisfy the write request by overwriting existing characters in the container, starting at the current character position. If you reach the end of the container before the write request is satisfied, you insert the remaining characters at the end.</P>
-<P>The implementation of <CODE>seek</CODE> is striaghforward. First, you calculate the new character position based on <CODE>off</CODE> and <CODE>way</CODE>: if <CODE>way</CODE> is <CODE>ios_base::beg</CODE>, the new character position is simply <CODE>off</CODE>; if <CODE>way</CODE> is <CODE>ios_base::cur</CODE>, the new character position is <CODE>pos_ + off</CODE>; if <CODE>way</CODE> is <CODE>ios_base::end</CODE>, the new character position is <CODE>container_.size() + off - 1</CODE>. Next, you check whether the new character position is a valid offset, and throw an exception if it isn't. Instances of <CODE>std::basic_streambuf</CODE> are allowed to return <CODE>-1</CODE> to indicate failure, but the policy of the Boost Iostreams library is that errors should be indicated by throwing an exception (<I>see</I> Exceptions). Finally, you set the new position and return it.</P>
+<P>The implementation of <CODE>seek</CODE> is straightforward. First, you calculate the new character position based on <CODE>off</CODE> and <CODE>way</CODE>: if <CODE>way</CODE> is <CODE>ios_base::beg</CODE>, the new character position is simply <CODE>off</CODE>; if <CODE>way</CODE> is <CODE>ios_base::cur</CODE>, the new character position is <CODE>pos_ + off</CODE>; if <CODE>way</CODE> is <CODE>ios_base::end</CODE>, the new character position is <CODE>container_.size() + off - 1</CODE>. Next, you check whether the new character position is a valid offset, and throw an exception if it isn't. Instances of <CODE>std::basic_streambuf</CODE> are allowed to return <CODE>-1</CODE> to indicate failure, but the policy of the Boost Iostreams library is that errors should be indicated by throwing an exception (<I>see</I> Exceptions). Finally, you set the new position and return it.</P>
<P>You can use a container_device as follows</P>
@@ -233,4 +233,4 @@
</P>
<!-- End Footer -->
-</BODY>
\ No newline at end of file
+</BODY>
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk