Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r80863 - in sandbox/enable_if/libs/enable_if/doc: . html html/enable_if_macros
From: rivorus_at_[hidden]
Date: 2012-10-05 00:07:44


Author: matt_calabrese
Date: 2012-10-05 00:07:43 EDT (Fri, 05 Oct 2012)
New Revision: 80863
URL: http://svn.boost.org/trac/boost/changeset/80863

Log:
Fixed typos in enable_if macros documentation.
Text files modified:
   sandbox/enable_if/libs/enable_if/doc/function_template_macros.qbk | 33 ++++++++++++++++-----------------
   sandbox/enable_if/libs/enable_if/doc/html/enable_if_macros/function_template_macros.html | 10 +++++-----
   sandbox/enable_if/libs/enable_if/doc/html/index.html | 2 +-
   3 files changed, 22 insertions(+), 23 deletions(-)

Modified: sandbox/enable_if/libs/enable_if/doc/function_template_macros.qbk
==============================================================================
--- sandbox/enable_if/libs/enable_if/doc/function_template_macros.qbk (original)
+++ sandbox/enable_if/libs/enable_if/doc/function_template_macros.qbk 2012-10-05 00:07:43 EDT (Fri, 05 Oct 2012)
@@ -20,13 +20,13 @@
 
 [heading Usage]
 
-The `BOOST_ENABLE_IF` family of macros is function-style macros that are
-intended to be used inside of a function template argument list as a means to
-enable or disable that template based on a compile-time condition. When using
-`BOOST_ENABLE_IF`, the condition must be a compliant [mpl_integral_constant] and
-when using `BOOST_ENABLE_IF_C` the condition must be a compile-time boolean
-constant expression. `BOOST_DISABLE_IF_C` and `BOOST_DISABLE_IF` behave
-similarly only they disable the template when the condition evaluates to `true`.
+The `BOOST_ENABLE_IF` macros are function-style macros that are intended to be
+used inside of a function template argument list as a means to enable or disable
+that template based on a compile-time condition. When using `BOOST_ENABLE_IF`,
+the condition must be a compliant [mpl_integral_constant] and when using
+`BOOST_ENABLE_IF_C` the condition must be a compile-time boolean constant
+expression. `BOOST_DISABLE_IF_C` and `BOOST_DISABLE_IF` behave similarly only
+they disable the template when the condition evaluates to `true`.
 
 [note The condition provided to these macros does not need to be dependent on a
 template argument.]
@@ -61,16 +61,15 @@
 
 [heading Usage]
 
-The `BOOST_LAZY_ENABLE_IF` family of macros is functionally similar to the
-corresponding [BOOST_ENABLE_IF] macros, only they also allow the user to
-introduce one or more named types that are evaluate if and only if the template
-is enabled. This is important when the function's return type, parameters, or
-exception specification need to refer to a type that may produce a compile-time
-error if the condition is not satisfied, or if the process of evaluating the
-type would negatively impact compile-times (in which case, the evaluation should
-be avoided when a different overload is picked). The syntax for specifying
-lazily evaluated types is `( name, definition)`. It is analogous to
-[boost_lazy_enable_if].
+The `BOOST_LAZY_ENABLE_IF` macros are functionally similar to the corresponding
+[BOOST_ENABLE_IF] macros, only they also allow the user to introduce one or more
+named types that are evaluate if and only if the template is enabled. This is
+important when the function's return type, parameters, or exception
+specification need to refer to a type that may produce a compile-time error if
+the condition is not satisfied, or if the process of evaluating the type would
+negatively impact compile-times (in which case, the evaluation should be avoided
+when a different overload is picked). The syntax for specifying lazily evaluated
+types is `( name, definition)`. It is analogous to [boost_lazy_enable_if].
 
 [heading Example]
 

Modified: sandbox/enable_if/libs/enable_if/doc/html/enable_if_macros/function_template_macros.html
==============================================================================
--- sandbox/enable_if/libs/enable_if/doc/html/enable_if_macros/function_template_macros.html (original)
+++ sandbox/enable_if/libs/enable_if/doc/html/enable_if_macros/function_template_macros.html 2012-10-05 00:07:43 EDT (Fri, 05 Oct 2012)
@@ -43,10 +43,10 @@
         <span class="phrase"><a name="enable_if_macros.function_template_macros.boost_enable_if.usage"></a></span><a class="link" href="function_template_macros.html#enable_if_macros.function_template_macros.boost_enable_if.usage">Usage</a>
       </h5>
 <p>
- The <code class="computeroutput"><span class="identifier">BOOST_ENABLE_IF</span></code> family
- of macros is function-style macros that are intended to be used inside of
- a function template argument list as a means to enable or disable that template
- based on a compile-time condition. When using <code class="computeroutput"><span class="identifier">BOOST_ENABLE_IF</span></code>,
+ The <code class="computeroutput"><span class="identifier">BOOST_ENABLE_IF</span></code> macros
+ are function-style macros that are intended to be used inside of a function
+ template argument list as a means to enable or disable that template based
+ on a compile-time condition. When using <code class="computeroutput"><span class="identifier">BOOST_ENABLE_IF</span></code>,
         the condition must be a compliant <a href="http://www.boost.org/doc/libs/release/libs/mpl/doc/refmanual/integral-constant.html" target="_top"><code class="literal">Boost.MPL</code>
         Integral Constant</a> and when using <code class="computeroutput"><span class="identifier">BOOST_ENABLE_IF_C</span></code>
         the condition must be a compile-time boolean constant expression. <code class="computeroutput"><span class="identifier">BOOST_DISABLE_IF_C</span></code> and <code class="computeroutput"><span class="identifier">BOOST_DISABLE_IF</span></code>
@@ -136,7 +136,7 @@
       </h5>
 <p>
         The <code class="computeroutput"><span class="identifier">BOOST_LAZY_ENABLE_IF</span></code>
- family of macros is functionally similar to the corresponding <a class="link" href="function_template_macros.html#enable_if_macros.function_template_macros.boost_enable_if" title="BOOST_ENABLE_IF"><code class="computeroutput"><span class="identifier">BOOST_ENABLE_IF</span></code></a> macros, only they
+ macros are functionally similar to the corresponding <a class="link" href="function_template_macros.html#enable_if_macros.function_template_macros.boost_enable_if" title="BOOST_ENABLE_IF"><code class="computeroutput"><span class="identifier">BOOST_ENABLE_IF</span></code></a> macros, only they
         also allow the user to introduce one or more named types that are evaluate
         if and only if the template is enabled. This is important when the function's
         return type, parameters, or exception specification need to refer to a type

Modified: sandbox/enable_if/libs/enable_if/doc/html/index.html
==============================================================================
--- sandbox/enable_if/libs/enable_if/doc/html/index.html (original)
+++ sandbox/enable_if/libs/enable_if/doc/html/index.html 2012-10-05 00:07:43 EDT (Fri, 05 Oct 2012)
@@ -101,7 +101,7 @@
 </div>
 </div>
 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: October 05, 2012 at 04:04:30 GMT</small></p></td>
+<td align="left"><p><small>Last revised: October 05, 2012 at 04:06:42 GMT</small></p></td>
 <td align="right"><div class="copyright-footer"></div></td>
 </tr></table>
 <hr>


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