[Boost-commit] svn:boost r72373 - trunk/libs/proto/doc/reference

Subject: [Boost-commit] svn:boost r72373 - trunk/libs/proto/doc/reference
From: eric_at_[hidden]
Date: 2011-06-03 03:42:07

Author: eric_niebler
Date: 2011-06-03 03:42:05 EDT (Fri, 03 Jun 2011)
New Revision: 72373
URL: http://svn.boost.org/trac/boost/changeset/72373

Log:
document the fact that flatten returns a Fusion Forward Sequence
Text files modified: 
   trunk/libs/proto/doc/reference/fusion.xml |    17 +++++++++++++++++                       
   1 files changed, 17 insertions(+), 0 deletions(-)

Modified: trunk/libs/proto/doc/reference/fusion.xml
==============================================================================
--- trunk/libs/proto/doc/reference/fusion.xml	(original)
+++ trunk/libs/proto/doc/reference/fusion.xml	2011-06-03 03:42:05 EDT (Fri, 03 Jun 2011)
@@ -19,6 +19,9 @@
               <computeroutput>a | b | c</computeroutput> has a flattened view with elements [a, b, c], even
               though the tree is grouped as <computeroutput>((a | b) | c)</computeroutput>.
             </para>
+            <para>
+              The resulting view is a Fusion Forward Sequence.
+            </para>
           </description>
           <inherit>
             <type><classname>proto::callable</classname></type>
@@ -56,6 +59,11 @@
               <parameter name="expr">
                 <paramtype>Expr &amp;</paramtype>
               </parameter>
+              <description>
+                <para>
+                  Returns a Fusion Forward Sequence representing a flattened view of <computeroutput>expr</computeroutput>.
+                </para>
+              </description>
             </method>
             <method name="operator()" cv="const">
               <type>typename <classname>proto::result_of::flatten</classname>&lt; Expr const &gt;::type const</type>
@@ -65,6 +73,11 @@
               <parameter name="expr">
                 <paramtype>Expr const &amp;</paramtype>
               </parameter>
+              <description>
+                <para>
+                  Returns a Fusion Forward Sequence representing a flattened view of <computeroutput>expr</computeroutput>.
+                </para>
+              </description>
             </method>
           </method-group>
         </struct>
@@ -81,6 +94,7 @@
             <functionname alt="proto::flatten">proto::flatten()</functionname></computeroutput></purpose>
           <typedef name="type">
             <type><emphasis>unspecified</emphasis></type>
+            <purpose>A Fusion Forward Sequence</purpose>
           </typedef>
         </struct>
       </namespace>
@@ -115,6 +129,9 @@
             view with elements [a, b, c], even though the tree is grouped as
             <computeroutput>((a | b) | c)</computeroutput>.
           </para>
+          <para>
+            The returned view is a Fusion Forward Sequence.
+          </para>
         </description>
       </overloaded-function>
     </namespace>