adds documentation for functional module

[SVN r36959]
This commit is contained in:
Tobias Schwinger
2007-02-15 23:11:24 +00:00
parent 67f0df4958
commit ca6f831b96
247 changed files with 8675 additions and 3833 deletions

View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>in</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../../../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
<link rel="up" href="../i_o.html" title="I/O">
<link rel="prev" href="../i_o.html" title="I/O">
@ -26,7 +26,7 @@
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.sequences.operators.i_o.in"></a><a href="in.html" title="in">in</a></h5></div></div></div>
<a name="fusion.sequences.operators.i_o.in.description"></a><h6>
<a name="id545949"></a>
<a name="id1074251"></a>
<a href="in.html#fusion.sequences.operators.i_o.in.description">Description</a>
</h6>
<p>
@ -34,7 +34,7 @@
stream.
</p>
<a name="fusion.sequences.operators.i_o.in.synopsis"></a><h6>
<a name="id545988"></a>
<a name="id1074285"></a>
<a href="in.html#fusion.sequences.operators.i_o.in.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
@ -43,7 +43,7 @@
<span class="keyword">operator</span><span class="special">&gt;&gt;(</span><span class="identifier">IStream</span><span class="special">&amp;</span> <span class="identifier">is</span><span class="special">,</span> <span class="identifier">Sequence</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
</pre>
<a name="fusion.sequences.operators.i_o.in.parameters"></a><h6>
<a name="id546134"></a>
<a name="id1074413"></a>
<a href="in.html#fusion.sequences.operators.i_o.in.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
@ -73,7 +73,7 @@
</tbody>
</table></div>
<a name="fusion.sequences.operators.i_o.in.expression_semantics"></a><h6>
<a name="id546226"></a>
<a name="id1074495"></a>
<a href="in.html#fusion.sequences.operators.i_o.in.expression_semantics">Expression
Semantics</a>
</h6>
@ -81,26 +81,26 @@
<span class="identifier">is</span> <span class="special">&gt;&gt;</span> <span class="identifier">seq</span>
</pre>
<p>
<span class="bold"><b>Return type</b></span>: IStream&amp;
<span class="bold"><strong>Return type</strong></span>: IStream&amp;
</p>
<p>
<span class="bold"><b>Semantics</b></span>: For each element, <tt class="computeroutput"><span class="identifier">e</span></tt>, in sequence, <tt class="computeroutput"><span class="identifier">seq</span></tt>,
call <tt class="computeroutput"><span class="identifier">is</span> <span class="special">&gt;&gt;</span>
<span class="identifier">e</span></tt>.
<span class="bold"><strong>Semantics</strong></span>: For each element, <code class="computeroutput"><span class="identifier">e</span></code>, in sequence, <code class="computeroutput"><span class="identifier">seq</span></code>,
call <code class="computeroutput"><span class="identifier">is</span> <span class="special">&gt;&gt;</span>
<span class="identifier">e</span></code>.
</p>
<a name="fusion.sequences.operators.i_o.in.header"></a><h6>
<a name="id546342"></a>
<a name="id1074597"></a>
<a href="in.html#fusion.sequences.operators.i_o.in.header">Header</a>
</h6>
<pre class="programlisting">
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">sequence</span><span class="special">/</span><span class="identifier">io</span><span class="special">/</span><span class="identifier">in</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.operators.i_o.in.example"></a><h6>
<a name="id546445"></a>
<a name="id1074688"></a>
<a href="in.html#fusion.sequences.operators.i_o.in.example">Example</a>
</h6>
<pre class="programlisting">
<a href="../../containers/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">,</span> <span class="keyword">char</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">;</span>
<a href="../../containers/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">,</span> <span class="keyword">char</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cin</span> <span class="special">&gt;&gt;</span> <span class="identifier">v</span><span class="special">;</span>
</pre>
</div>

View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>out</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../../../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
<link rel="up" href="../i_o.html" title="I/O">
<link rel="prev" href="in.html" title="in">
@ -26,7 +26,7 @@
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.sequences.operators.i_o.out"></a><a href="out.html" title="out">out</a></h5></div></div></div>
<a name="fusion.sequences.operators.i_o.out.description"></a><h6>
<a name="id546604"></a>
<a name="id1074828"></a>
<a href="out.html#fusion.sequences.operators.i_o.out.description">Description</a>
</h6>
<p>
@ -34,7 +34,7 @@
stream.
</p>
<a name="fusion.sequences.operators.i_o.out.synopsis"></a><h6>
<a name="id546643"></a>
<a name="id1074862"></a>
<a href="out.html#fusion.sequences.operators.i_o.out.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
@ -43,7 +43,7 @@
<span class="keyword">operator</span><span class="special">&lt;&lt;(</span><span class="identifier">OStream</span><span class="special">&amp;</span> <span class="identifier">os</span><span class="special">,</span> <span class="identifier">Sequence</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
</pre>
<a name="fusion.sequences.operators.i_o.out.parameters"></a><h6>
<a name="id546788"></a>
<a name="id1074990"></a>
<a href="out.html#fusion.sequences.operators.i_o.out.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
@ -73,7 +73,7 @@
</tbody>
</table></div>
<a name="fusion.sequences.operators.i_o.out.expression_semantics"></a><h6>
<a name="id546879"></a>
<a name="id1075070"></a>
<a href="out.html#fusion.sequences.operators.i_o.out.expression_semantics">Expression
Semantics</a>
</h6>
@ -81,26 +81,26 @@
<span class="identifier">os</span> <span class="special">&lt;&lt;</span> <span class="identifier">seq</span>
</pre>
<p>
<span class="bold"><b>Return type</b></span>: OStream&amp;
<span class="bold"><strong>Return type</strong></span>: OStream&amp;
</p>
<p>
<span class="bold"><b>Semantics</b></span>: For each element, <tt class="computeroutput"><span class="identifier">e</span></tt>, in sequence, <tt class="computeroutput"><span class="identifier">seq</span></tt>,
call <tt class="computeroutput"><span class="identifier">os</span> <span class="special">&lt;&lt;</span>
<span class="identifier">e</span></tt>.
<span class="bold"><strong>Semantics</strong></span>: For each element, <code class="computeroutput"><span class="identifier">e</span></code>, in sequence, <code class="computeroutput"><span class="identifier">seq</span></code>,
call <code class="computeroutput"><span class="identifier">os</span> <span class="special">&lt;&lt;</span>
<span class="identifier">e</span></code>.
</p>
<a name="fusion.sequences.operators.i_o.out.header"></a><h6>
<a name="id546994"></a>
<a name="id1075172"></a>
<a href="out.html#fusion.sequences.operators.i_o.out.header">Header</a>
</h6>
<pre class="programlisting">
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">sequence</span><span class="special">/</span><span class="identifier">io</span><span class="special">/</span><span class="identifier">out</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.operators.i_o.out.example"></a><h6>
<a name="id547098"></a>
<a name="id1075264"></a>
<a href="out.html#fusion.sequences.operators.i_o.out.example">Example</a>
</h6>
<pre class="programlisting">
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <a href="../../generation/functions/make_vector.html" title="make_vector"><tt class="computeroutput"><span class="identifier">make_vector</span></tt></a><span class="special">(</span><span class="number">123</span><span class="special">,</span> <span class="string">"Hello"</span><span class="special">,</span> <span class="char">'x'</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <a href="../../generation/functions/make_vector.html" title="make_vector"><code class="computeroutput"><span class="identifier">make_vector</span></code></a><span class="special">(</span><span class="number">123</span><span class="special">,</span> <span class="string">"Hello"</span><span class="special">,</span> <span class="char">'x'</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>