Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r72159 - in branches/pplib/variadics/libs/preprocessor/doc: . headers/facilities ref topics
From: eldiener_at_[hidden]
Date: 2011-05-25 11:58:18


Author: eldiener
Date: 2011-05-25 11:58:16 EDT (Wed, 25 May 2011)
New Revision: 72159
URL: http://svn.boost.org/trac/boost/changeset/72159

Log:
Removed BOOST_PP_CALL_OVERLOAD documentation.
Removed:
   branches/pplib/variadics/libs/preprocessor/doc/ref/call_overload.html
Text files modified:
   branches/pplib/variadics/libs/preprocessor/doc/headers/facilities/overload.html | 13 ++++++-------
   branches/pplib/variadics/libs/preprocessor/doc/ref.html | 13 ++++++-------
   branches/pplib/variadics/libs/preprocessor/doc/topics/variadic_macros.html | 31 ++++++++++++-------------------
   3 files changed, 24 insertions(+), 33 deletions(-)

Modified: branches/pplib/variadics/libs/preprocessor/doc/headers/facilities/overload.html
==============================================================================
--- branches/pplib/variadics/libs/preprocessor/doc/headers/facilities/overload.html (original)
+++ branches/pplib/variadics/libs/preprocessor/doc/headers/facilities/overload.html 2011-05-25 11:58:16 EDT (Wed, 25 May 2011)
@@ -1,9 +1,9 @@
 <html>
-<head>
- <title>facilities/overload.hpp</title>
+ <head>
+ <title>facilities/overload.hpp</title>
         <link rel="stylesheet" type="text/css" href="../../styles.css">
-</head>
-<body>
+ </head>
+ <body>
         <div style="margin-left: 0px;">
                 The <b>facilities/overload.hpp</b> header defines variadic macros that overload non-variadic macros to accept different numbers of parameters.
         </div>
@@ -14,7 +14,6 @@
         <h4>Contents</h4>
                 <ul>
                         <li>BOOST_PP_OVERLOAD (v)</li>
- <li>BOOST_PP_CALL_OVERLOAD (v)</li>
                 </ul>
         <hr size="1">
         <div style="margin-left: 0px;">
@@ -25,5 +24,5 @@
                 accompanying file LICENSE_1_0.txt or
                 copy at www.boost.org/LICENSE_1_0.txt)</small></p>
         </div>
-</body>
-</html>
+ </body>
+</html>
\ No newline at end of file

Modified: branches/pplib/variadics/libs/preprocessor/doc/ref.html
==============================================================================
--- branches/pplib/variadics/libs/preprocessor/doc/ref.html (original)
+++ branches/pplib/variadics/libs/preprocessor/doc/ref.html 2011-05-25 11:58:16 EDT (Wed, 25 May 2011)
@@ -1,10 +1,10 @@
 <html>
-<head>
- <title>ref.html</title>
+ <head>
+ <title>ref.html</title>
   <link rel="stylesheet" type="text/css" href="styles.css">
   <base target="desc">
-</head>
-<body>
+ </head>
+ <body>
 <h4> Reference <small>[back]</small>
 </h4>
 <ul>
@@ -43,7 +43,6 @@
   <li>BITXOR</li>
   <li>BOOL</li>
 <!-- C -->
- <li>CALL_OVERLOAD</li>
   <li>CAT</li>
   <li>COMMA</li>
   <li>COMMA_IF</li>
@@ -299,5 +298,5 @@
 (See accompanying file LICENSE_1_0.txt or copy at
 http://www.boost.org/LICENSE_1_0.txt)
 -->
-</body>
-</html>
+ </body>
+</html>
\ No newline at end of file

Deleted: branches/pplib/variadics/libs/preprocessor/doc/ref/call_overload.html
==============================================================================
--- branches/pplib/variadics/libs/preprocessor/doc/ref/call_overload.html 2011-05-25 11:58:16 EDT (Wed, 25 May 2011)
+++ (empty file)
@@ -1,60 +0,0 @@
-<html>
-<head>
- <title>BOOST_PP_CALL_OVERLOAD</title>
- <link rel="stylesheet" type="text/css" href="../styles.css">
-</head>
-<body>
-<div style="margin-left: 0px;"> The <b>BOOST_PP_CALL_OVERLOAD</b> variadic macro invokes a non-variadic macro having a given number of parameters.<br>
- </div>
-<h4>Usage</h4>
-<div class="code"> <b>BOOST_PP_CALL_OVERLOAD</b>(<i>prefix</i>,...) <sup>(v)</sup><br>
- </div>
-<h4>Arguments</h4>
-<dl>
-<dt>prefix<br>
-</dt><dd>
- The prefix of the non-variadic macro name.</dd><dt>...<br>
-</dt><dd><i>
- Variadic data</i>. The number of variadic data
-elements, as determined by BOOST_PP_VARIADIC_SIZE, is appended to the
-prefix to form the output non-variadic macro name, and then the non-variadic macro name is invoked passing this <i>variadic data</i> as parameters.<br>
-</dd>
-</dl>
-<h4>Remarks</h4>
-<div> This macro creates a macro name which depends on the number of
-elements of variadic data using BOOST_PP_OVERLOAD and then invokes that
-macro passing the <i>variadic data</i>. In this way one can invoke a
-variadic macro with a variable number of parameters which calls one of
-a series of non-variadic macros doing very similar things. If such a macro name does not exist taking the specified number of
-arguments as determined by the number of elements of the variadic data,
-a preprocessor error will occur.<br>
-<br>
-The macro overcomes a problem using BOOST_PP_OVERLOAD with Visual C++.
-However, when used with Visual C++ the macro can not be recursively
-invoked, so BOOST_PP_OVERLOAD must be used instead in a slightly
-different way. To see how this is done look at the code in
-boost/preprocesor/tuple/detail/use_overload.hpp. If there is no need to
-recursively invoke BOOST_PP_OVERLOAD the macro can be used with Visual
-C++ without any problems. The recursive invocation problem using
-BOOST_PP_CALL_OVERLOAD does not exist for other compilers tested.<br>
-</div>
-<h4>See Also</h4>
-<ul>
-<li>BOOST_PP_OVERLOAD</li>
-</ul>
-<h4>Requirements</h4>
-<div> <b>Header:</b> &nbsp;<boost/preprocessor/facilities/overload.hpp>
-</div>
-<h4>Sample Code</h4>
-<div>
-<pre>#include &lt;boost/preprocessor/facilities/overload.hpp&gt;<br>#include &lt;boost/preprocessor/arithmetic/add.hpp&gt;<br><br>#define MACRO_1(number) MACRO_2(number,10)<br>#define MACRO_2(number1,number2) BOOST_PP_ADD(number1,number2)<br><br>#define MACRO_ADD_NUMBERS(...) BOOST_PP_CALL_OVERLOAD(MACRO_,__VA_ARGS__)<br><br>MACRO_ADD_NUMBERS(5) // output is 15<br>MACRO_ADD_NUMBERS(3,6) // output is 9<br></pre>
-</div>
-<hr size="1">
-<div style="margin-left: 0px;"> <i></i><i>© Copyright Edward Diener 2011</i> </div>
-<div style="margin-left: 0px;">
-<p><small>Distributed under the Boost Software License, Version 1.0.
-(See accompanying file LICENSE_1_0.txt
-or copy at www.boost.org/LICENSE_1_0.txt)</small></p>
-</div>
-</body>
-</html>
\ No newline at end of file

Modified: branches/pplib/variadics/libs/preprocessor/doc/topics/variadic_macros.html
==============================================================================
--- branches/pplib/variadics/libs/preprocessor/doc/topics/variadic_macros.html (original)
+++ branches/pplib/variadics/libs/preprocessor/doc/topics/variadic_macros.html 2011-05-25 11:58:16 EDT (Wed, 25 May 2011)
@@ -1,11 +1,12 @@
-<html><head>
-<title>variadic_macros.html</title>
-<link rel="stylesheet" type="text/css" href="../styles.css">
-<style>
-u { font-weight: normal; text-decoration: none; }
-</style>
-</head>
-<body>
+<html>
+ <head>
+ <title>variadic_macros.html</title>
+ <link rel="stylesheet" type="text/css" href="../styles.css">
+ <style>
+ u { font-weight: normal; text-decoration: none; }
+ </style>
+ </head>
+ <body>
 <h4>Variadic Macros</h4>
 <div> Variadic macros are supported by a number of compilers.
 They are
@@ -203,15 +204,7 @@
 </u></h4>
 <div class="code">
 <pre>#define MACRO_ARG_2(x,y) BOOST_PP_ADD(x,y)<br>#define VAR_MACRO(...) __VA_ARGS__<br><br>/* The following will work correctly */<br><br>int xx = BOOST_PP_OVERLOAD(MACRO_ARG_,VAR_MACRO(2,3))(VAR_MACRO(2,3));<br><br>/* For Visual C++ it is necessary to do this */<br><br>int xx = <br>BOOST_PP_CAT(BOOST_PP_OVERLOAD(MACRO_ARG_,VAR_MACRO(2,3))(VAR_MACRO(2,3)),BOOST_PP_EMPTY());</pre>
-</div>
-<h4>Example<u> - Passing variadic data as a whole to
-BOOST_PP_CALL_OVERLOAD
-and on to a non-variadic macro.<br>
-</u></h4>
-<div class="code">
-<pre>#define MACRO_ARG_2(x,y) BOOST_PP_ADD(x,y)<br>#define VAR_MACRO(...) __VA_ARGS__<br><br>/* The following will work correctly */<br><br>int xx = BOOST_PP_CALL_OVERLOAD(MACRO_ARG_,VAR_MACRO(2,3));</pre>
-</div>
-<br>
+</div><br>
 <div>Although these techniques will work when passing variadic
 data to
 non-variadic macros, it is much better and less problematical to
@@ -234,7 +227,6 @@
 <li>BOOST_PP_SEQ_ENUM</li>
 <li>BOOST_PP_TUPLE_ENUM</li>
 <li>BOOST_PP_OVERLOAD</li>
-<li>BOOST_PP_CALL_OVERLOAD</li>
 </ul>
 <hr size="1">
 <div style="margin-left: 0px;"> <i>© Copyright
@@ -246,4 +238,5 @@
 (See accompanying file LICENSE_1_0.txt
 or copy at www.boost.org/LICENSE_1_0.txt)</small></p>
 </div>
-</body></html>
\ No newline at end of file
+ </body>
+</html>
\ No newline at end of file


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