Improving docs

[SVN r12598]
This commit is contained in:
Vesa Karvonen
2002-01-31 08:12:31 +00:00
parent 756563fb76
commit 31b1b43b9f
2 changed files with 11 additions and 13 deletions

View File

@ -40,12 +40,11 @@ literal.
F(R,X) usually expands to a tuple of the same number of elements. F(R,X) usually expands to a tuple of the same number of elements.
- <B>I</B> is the state instantiation macro. - <B>I</B> is the state instantiation macro.
- <B>R</B> is the recursion depth and should only be used as a parameter to - <B>R</B> is the recursion depth and should only be used as a parameter to
other macros implemented using BOOST_PP_FOR() or for invoking other macros using BOOST_PP_FOR() or for invoking BOOST_PP_FOR##R() directly.
BOOST_PP_FOR##R() directly. For each macro implemented using BOOST_PP_FOR(), For each macro using BOOST_PP_FOR(), there is a version of the macro,
there is a version of the macro, distinguished by the R suffix, that accepts distinguished by the R suffix, that accepts an additional recursion depth as
an additional recursion depth as the first parameter. This technique is the first parameter. This technique is necessary to avoid recursively
necessary to avoid recursively expanding the same macro again, which is not expanding the same macro again, which is not permitted by the C++ preprocessor.
permitted by the C++ preprocessor.
<H3>BOOST_PP_REPEAT() vs BOOST_PP_FOR()</H3> <H3>BOOST_PP_REPEAT() vs BOOST_PP_FOR()</H3>

View File

@ -39,13 +39,12 @@ integer literal.
- <B>F</B> is the iterated macro. Note that if the state is a tuple, then - <B>F</B> is the iterated macro. Note that if the state is a tuple, then
F(D,X) usually expands to a tuple of the same number of elements. F(D,X) usually expands to a tuple of the same number of elements.
- <B>D</B> is the recursion depth and should only be used as a parameter - <B>D</B> is the recursion depth and should only be used as a parameter
to other macros implemented using BOOST_PP_WHILE(). Such macros include to other macros using BOOST_PP_WHILE(). Such macros include BOOST_PP_ADD()
BOOST_PP_ADD() and other arithmetic operations. For each macro implemented and other arithmetic operations. For each macro using BOOST_PP_WHILE(),
using BOOST_PP_WHILE(), there is a version of the macro, distinguished by there is a version of the macro, distinguished by the D suffix (e.g.
the D suffix (e.g. BOOST_PP_ADD_D()), that accepts an additional recursion BOOST_PP_ADD_D()), that accepts an additional recursion depth as the first
depth as the first parameter. This technique is necessary to avoid parameter. This technique is necessary to avoid recursively expanding the
recursively expanding the same macro again, which is not permitted by the same macro again, which is not permitted by the C++ preprocessor.
C++ preprocessor.
NOTE: The value of the D parameter may exceed BOOST_PP_LIMIT_MAG. NOTE: The value of the D parameter may exceed BOOST_PP_LIMIT_MAG.