Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r62535 - trunk/libs/proto/doc/reference
From: eric_at_[hidden]
Date: 2010-06-07 21:13:57


Author: eric_niebler
Date: 2010-06-07 21:13:56 EDT (Mon, 07 Jun 2010)
New Revision: 62535
URL: http://svn.boost.org/trac/boost/changeset/62535

Log:
bring reference docs into agreement with current code
Text files modified:
   trunk/libs/proto/doc/reference/domain.xml | 17 +++++++++++++++--
   trunk/libs/proto/doc/reference/operators.xml | 7 +------
   2 files changed, 16 insertions(+), 8 deletions(-)

Modified: trunk/libs/proto/doc/reference/domain.xml
==============================================================================
--- trunk/libs/proto/doc/reference/domain.xml (original)
+++ trunk/libs/proto/doc/reference/domain.xml 2010-06-07 21:13:56 EDT (Mon, 07 Jun 2010)
@@ -17,11 +17,16 @@
           <template-type-parameter name="Grammar">
             <default><classname>proto::_</classname></default>
           </template-type-parameter>
+ <template-type-parameter name="Super">
+ <default><replaceable>unspecified</replaceable></default>
+ </template-type-parameter>
         </template>
         <inherit><type>Generator</type></inherit>
         <purpose>For use in defining domain tags to be used with <computeroutput>
- <classname alt="proto::extends">proto::extends&lt;&gt;</classname></computeroutput>. A
- <emphasis>domain</emphasis> associates an expression type with a <emphasis>generator</emphasis>,
+ <classname alt="proto::extends">proto::extends&lt;&gt;</classname></computeroutput>,
+ <computeroutput><macroname>BOOST_PROTO_EXTENDS</macroname>()</computeroutput> and
+ <computeroutput><macroname>BOOST_PROTO_DEFINE_OPERATORS</macroname>()</computeroutput>.
+ A <emphasis>domain</emphasis> associates an expression type with a <emphasis>generator</emphasis>,
           and optionally a <emphasis>grammar</emphasis>.
         </purpose>
         <description>
@@ -37,6 +42,11 @@
             </computeroutput>, which makes all expressions valid within the domain.
           </para>
           <para>
+ The Super declares the domain currently being defined to be a sub-domain of Super. An expression in
+ a sub-domain can be freely combined with expressions in its super-domain (and <emphasis>its</emphasis>
+ super-domain, etc.).
+ </para>
+ <para>
             Example: <programlisting> template&lt;typename Expr&gt;
  struct MyExpr;
 
@@ -67,6 +77,9 @@
         <typedef name="proto_generator">
           <type>Generator</type>
         </typedef>
+ <typedef name="proto_super_domain">
+ <type>Super</type>
+ </typedef>
       </struct>
 
       <!-- proto::default_domain -->

Modified: trunk/libs/proto/doc/reference/operators.xml
==============================================================================
--- trunk/libs/proto/doc/reference/operators.xml (original)
+++ trunk/libs/proto/doc/reference/operators.xml 2010-06-07 21:13:56 EDT (Mon, 07 Jun 2010)
@@ -7,7 +7,7 @@
         <template>
           <template-type-parameter name="T"/>
         </template>
- <inherit><type>mpl::false_</type></inherit>
+ <inherit><type><classname>is_expr</classname>&lt; T &gt;</type></inherit>
         <purpose>Boolean metafunction that can be used to enable the operator overloads in the
         <computeroutput>exops</computeroutput> namespace for the specified non-Proto terminal type.</purpose>
       </struct>
@@ -1786,11 +1786,6 @@
           <paramtype>A2 const &amp;</paramtype>
         </parameter>
       </function>
- <namespace name="exops">
- <data-member name="(is_extension, default_domain)">
- <type><macroname>BOOST_PROTO_DEFINE_OPERATORS</macroname></type>
- </data-member>
- </namespace>
     </namespace>
   </namespace>
   <macro name="BOOST_PROTO_DEFINE_OPERATORS" kind="functionlike">


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