|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r76961 - in trunk/libs/iostreams/doc: classes concepts guide tutorial
From: dnljms_at_[hidden]
Date: 2012-02-10 02:46:59
Author: danieljames
Date: 2012-02-10 02:46:51 EST (Fri, 10 Feb 2012)
New Revision: 76961
URL: http://svn.boost.org/trac/boost/changeset/76961
Log:
Iostreams: More documentation fixes. Refs #6541.
Patch by Steven Samuel Cole. Modified for an extra typo I noticed and to
preserve a link.
Text files modified:
trunk/libs/iostreams/doc/classes/device.html | 2 +-
trunk/libs/iostreams/doc/concepts/multi_character.html | 6 +++---
trunk/libs/iostreams/doc/guide/modes.html | 8 ++++----
trunk/libs/iostreams/doc/tutorial/container_source.html | 2 +-
trunk/libs/iostreams/doc/tutorial/writing_filters.html | 2 +-
5 files changed, 10 insertions(+), 10 deletions(-)
Modified: trunk/libs/iostreams/doc/classes/device.html
==============================================================================
--- trunk/libs/iostreams/doc/classes/device.html (original)
+++ trunk/libs/iostreams/doc/classes/device.html 2012-02-10 02:46:51 EST (Fri, 10 Feb 2012)
@@ -26,7 +26,7 @@
<H2>Description</H2>
<P>
- The class template <CODE>device</CODE>, its subcass <CODE>wdevice</CODE> and their specializations <CODE>source</CODE>, <CODE>sink</CODE>, <CODE>wsource</CODE> and <CODE>wsink</CODE> are provided by the Iostreams library to ease the definitions of new models of the various Device Concepts. These templates and <CODE>typedef</CODE>s are inteded to be used as base classes for user-defined Devices. They supply the member types <CODE>char_type</CODE> and <CODE>category</CODE> used by the Iostreams library.
+ The class template <CODE>device</CODE>, its subclass <CODE>wdevice</CODE> and their specializations <CODE>source</CODE>, <CODE>sink</CODE>, <CODE>wsource</CODE> and <CODE>wsink</CODE> are provided by the Iostreams library to ease the definitions of new models of the various Device Concepts. These templates and <CODE>typedef</CODE>s are intended to be used as base classes for user-defined Devices. They supply the member types <CODE>char_type</CODE> and <CODE>category</CODE> used by the Iostreams library.
</P>
<P>
The supplied <CODE>category</CODE> member is convertible to closable_tag and to localizable_tag. This allows users to define models of the concepts Closable and Localizable simply by providing definitions of member functions <CODE>close</CODE> and <CODE>imbue</CODE>.
Modified: trunk/libs/iostreams/doc/concepts/multi_character.html
==============================================================================
--- trunk/libs/iostreams/doc/concepts/multi_character.html (original)
+++ trunk/libs/iostreams/doc/concepts/multi_character.html 2012-02-10 02:46:51 EST (Fri, 10 Feb 2012)
@@ -1,7 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
<HEAD>
- <TITLE>Mutli-Character Filter</TITLE>
+ <TITLE>Multi-Character Filter</TITLE>
<LINK REL="stylesheet" HREF="../../../../boost.css">
<LINK REL="stylesheet" HREF="../theme/iostreams.css">
</HEAD>
@@ -9,14 +9,14 @@
<!-- Begin Banner -->
- <H1 CLASS="title">Mutli-Character Filter</H1>
+ <H1 CLASS="title">Multi-Character Filter</H1>
<HR CLASS="banner">
<!-- End Banner -->
<H2>Description</H2>
-<P>Filter which provides access to its controlled sequence or sequences several characters at a time. The difference between a Filter which is Mutli-Character and one which is not is reflected in the specifications of the various Filter refinements. <I>See</I>, <I>e.g.</I>, InputFilter and OutputFilter.</P>
+<P>Filter which provides access to its controlled sequence or sequences several characters at a time. The difference between a Filter which is Multi-Character and one which is not is reflected in the specifications of the various Filter refinements. <I>See</I>, <I>e.g.</I>, InputFilter and OutputFilter.</P>
<H2>Refinement of</H2>
Modified: trunk/libs/iostreams/doc/guide/modes.html
==============================================================================
--- trunk/libs/iostreams/doc/guide/modes.html (original)
+++ trunk/libs/iostreams/doc/guide/modes.html 2012-02-10 02:46:51 EST (Fri, 10 Feb 2012)
@@ -29,7 +29,7 @@
<DL class="page-index">
<DT>Overview</DT>
<DT>Definitions of the Modes</DT>
- <DT>Mode Hierchy Diagrams</DT>
+ <DT>Mode Hierarchy Diagrams</DT>
<DT>Mode Tags</DT>
<DT>The metafunction mode_of</DT>
</DL>
@@ -48,7 +48,7 @@
</P>
<P>
- The Iostreams library supports eight modes, described in the next section (<I>see also</I> <A CLASS="caption_ref" HREF="#mode_hierchy_diagrams">Figure 2</A>). Of these, four are most import (<I>see </I> <A CLASS="caption_ref" HREF="#mode_hierchy_diagrams">Figure 1</A>). The two modes input and output are by far the most common. Readers new to the Iostreams library should feel free to concentrate primarily on these two modes.
+ The Iostreams library supports eight modes, described in the next section (<I>see also</I> <A CLASS="caption_ref" HREF="#mode_hierarchy_diagrams">Figure 2</A>). Of these, four are most import (<I>see </I> <A CLASS="caption_ref" HREF="#mode_hierarchy_diagrams">Figure 1</A>). The two modes input and output are by far the most common. Readers new to the Iostreams library should feel free to concentrate primarily on these two modes.
</P>
<A NAME="definitions"></A>
@@ -168,8 +168,8 @@
For more on the selection of modes, see the Rationale.
</P>
-<A NAME="mode_hierchy_diagrams"></A>
-<H2>Mode Hierchy Diagrams</H2>
+<A ID="mode_hierchy_diagrams"></A>
+<H2 ID="mode_hierarchy_diagrams">Mode Hierarchy Diagrams</H2>
<P>The following diagrams display the refinement hierarchies among modes.</P>
Modified: trunk/libs/iostreams/doc/tutorial/container_source.html
==============================================================================
--- trunk/libs/iostreams/doc/tutorial/container_source.html (original)
+++ trunk/libs/iostreams/doc/tutorial/container_source.html 2012-02-10 02:46:51 EST (Fri, 10 Feb 2012)
@@ -53,7 +53,7 @@
<P>Here the member type char_type indicates the type of characters handled by my_source, which will almost always be <CODE>char</CODE> or <CODE>wchar_t</CODE>. The member type category indicates which of the fundamental i/o operations are supported by the device. The category tag source_tag indicates that only read is supported.</P>
-<P>The member function <CODE>read</CODE> reads up to <CODE>n</CODE> character into the buffer <CODE>s</CODE> and returns the number of character read, unless that number is <CODE>0</CODE> and end-of-stream has been reached, in which case the special value <CODE>-1</CODE> is returned. In general, a Source's member function <CODE>read</CODE> may return fewer characters than requested even though end-of-stream has not been reached; such Sources are called <I>non-blocking</I>. Non-blocking Devices do not interact well with standard streams and stream buffers, however, so most devices should be Blocking. <I>See</I> Asynchronous and Non-Blocking I/O.</P>
+<P>The member function <CODE>read</CODE> reads up to <CODE>n</CODE> characters into the buffer <CODE>s</CODE> and returns the number of characters read, unless that number is <CODE>0</CODE> and end-of-stream has been reached, in which case the special value <CODE>-1</CODE> is returned. In general, a Source's member function <CODE>read</CODE> may return fewer characters than requested even though end-of-stream has not been reached; such Sources are called <I>non-blocking</I>. Non-blocking Devices do not interact well with standard streams and stream buffers, however, so most devices should be Blocking. <I>See</I> Asynchronous and Non-Blocking I/O.</P>
<P>You could also write the above example as follows:</P>
Modified: trunk/libs/iostreams/doc/tutorial/writing_filters.html
==============================================================================
--- trunk/libs/iostreams/doc/tutorial/writing_filters.html (original)
+++ trunk/libs/iostreams/doc/tutorial/writing_filters.html 2012-02-10 02:46:51 EST (Fri, 10 Feb 2012)
@@ -27,7 +27,7 @@
<A NAME="filter_overview"></A>
<H2>2.2.1. Overview: InputFilters, OutputFilters and Filter Helpers</H2>
-<P>Filters are used to modify character sequences. For example, you might use a filter to replace all instances of one word with another, to convert all alphabetic characters to lower case or to encrypt a document. Sometimes the filter is a mere observer; in this case the filtered character sequence if the same as the unfiltered sequence. For example, you might use a filter to count the number of occurences of a given word.</P>
+<P>Filters are used to modify character sequences. For example, you might use a filter to replace all instances of one word with another, to convert all alphabetic characters to lower case or to encrypt a document. Sometimes the filter is a mere observer; in this case the filtered character sequence if the same as the unfiltered sequence. For example, you might use a filter to count the number of occurrences of a given word.</P>
<A NAME="input_filters_and_output_filters"></A>
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