From 03b37c307fad4477eca0b66f790db86c772b796f Mon Sep 17 00:00:00 2001
From: Vesa Karvonen <vesa.karvonen@housemarque.fi>
Date: Sun, 10 Mar 2002 12:31:37 +0000
Subject: [PATCH] Docs updated

[SVN r13169]
---
 doc/reference/for.htm                         | 30 +++++++++----------
 doc/reference/list_fold_left.htm              | 13 ++++++++
 doc/reference/list_fold_right.htm             | 13 ++++++++
 doc/reference/list_for_each.htm               | 13 ++++++++
 doc/reference/list_for_each_i.htm             | 13 ++++++++
 doc/reference/list_for_each_product.htm       | 19 ++++++++++++
 doc/reference/logical_bool.htm                |  2 ++
 doc/reference/repeat.htm                      | 13 ++++++++
 doc/reference/stringize.htm                   |  2 ++
 doc/reference/while.htm                       | 14 +++++++++
 include/boost/preprocessor/for.hpp            | 30 +++++++++----------
 include/boost/preprocessor/list/fold_left.hpp |  2 +-
 .../boost/preprocessor/list/fold_right.hpp    | 13 ++++++++
 include/boost/preprocessor/list/for_each.hpp  | 13 ++++++++
 .../boost/preprocessor/list/for_each_i.hpp    | 13 ++++++++
 .../preprocessor/list/for_each_product.hpp    | 19 ++++++++++++
 include/boost/preprocessor/while.hpp          | 14 +++++++++
 17 files changed, 205 insertions(+), 31 deletions(-)

diff --git a/doc/reference/for.htm b/doc/reference/for.htm
index 037a3fa..c585080 100644
--- a/doc/reference/for.htm
+++ b/doc/reference/for.htm
@@ -38,6 +38,21 @@
 
 <p>The length of the sequence is determined by <code>C(R,X)</code>.</p>
 
+<p>For example,</p>
+
+<pre>
+  #define C(R,X) <a href="comparison_less.htm#BOOST_PP_LESS">BOOST_PP_LESS</a>(<a href="tuple_elem.htm#BOOST_PP_TUPLE_ELEM">BOOST_PP_TUPLE_ELEM</a>(2,0,X),<a href="tuple_elem.htm#BOOST_PP_TUPLE_ELEM">BOOST_PP_TUPLE_ELEM</a>(2,1,X))
+  #define F(R,X) (<a href="inc.htm#BOOST_PP_INC">BOOST_PP_INC</a>(<a href="tuple_elem.htm#BOOST_PP_TUPLE_ELEM">BOOST_PP_TUPLE_ELEM</a>(2,0,X)),<a href="tuple_elem.htm#BOOST_PP_TUPLE_ELEM">BOOST_PP_TUPLE_ELEM</a>(2,1,X))
+  #define I(R,X) <a href="tuple_elem.htm#BOOST_PP_TUPLE_ELEM">BOOST_PP_TUPLE_ELEM</a>(2,0,X)
+  <a href="for.htm#BOOST_PP_FOR">BOOST_PP_FOR</a>((0,3),C,F,I)
+</pre>
+
+<p>expands to:</p>
+
+<pre>
+  0 1 2
+</pre>
+
 <h3>Legend</h3>
 <ul>
   <li><b>X</b> is the current state of iteration. The state is usually a tuple.</li>
@@ -55,21 +70,6 @@
       by the C++ preprocessor.</li>
 </ul>
 
-<p>For example,</p>
-
-<pre>
-  #define C(R,X) <a href="comparison_less.htm#BOOST_PP_LESS">BOOST_PP_LESS</a>(<a href="tuple_elem.htm#BOOST_PP_TUPLE_ELEM">BOOST_PP_TUPLE_ELEM</a>(2,0,X),<a href="tuple_elem.htm#BOOST_PP_TUPLE_ELEM">BOOST_PP_TUPLE_ELEM</a>(2,1,X))
-  #define F(R,X) (<a href="inc.htm#BOOST_PP_INC">BOOST_PP_INC</a>(<a href="tuple_elem.htm#BOOST_PP_TUPLE_ELEM">BOOST_PP_TUPLE_ELEM</a>(2,0,X)),<a href="tuple_elem.htm#BOOST_PP_TUPLE_ELEM">BOOST_PP_TUPLE_ELEM</a>(2,1,X))
-  #define I(R,X) <a href="tuple_elem.htm#BOOST_PP_TUPLE_ELEM">BOOST_PP_TUPLE_ELEM</a>(2,0,X)
-  <a href="for.htm#BOOST_PP_FOR">BOOST_PP_FOR</a>((0,3),C,F,I)
-</pre>
-
-<p>expands to:</p>
-
-<pre>
-  0 1 2
-</pre>
-
 <h3><a href="repeat.htm#BOOST_PP_REPEAT">BOOST_PP_REPEAT</a>() vs <a href="for.htm#BOOST_PP_FOR">BOOST_PP_FOR</a>()</h3>
 
 <p><a href="for.htm#BOOST_PP_FOR">BOOST_PP_FOR</a>() is a generalization of <a href="repeat.htm#BOOST_PP_REPEAT">BOOST_PP_REPEAT</a>(). This means that
diff --git a/doc/reference/list_fold_left.htm b/doc/reference/list_fold_left.htm
index 2b2f1c2..ca987de 100644
--- a/doc/reference/list_fold_left.htm
+++ b/doc/reference/list_fold_left.htm
@@ -40,6 +40,19 @@ list <code>L</code> (from the left or the start of the list).</p>
   )
 </pre>
 
+<p>For example,</p>
+
+<pre>
+  #define TEST(D,P,X) <a href="cat.htm#BOOST_PP_CAT">BOOST_PP_CAT</a>(P,X)
+  <a href="list_fold_left.htm#BOOST_PP_LIST_FOLD_LEFT">BOOST_PP_LIST_FOLD_LEFT</a>(TEST,_,<a href="tuple_to_list.htm#BOOST_PP_TUPLE_TO_LIST">BOOST_PP_TUPLE_TO_LIST</a>(3,(A,B,C)))
+</pre>
+
+<p>expands to:</p>
+
+<pre>
+  _ABC
+</pre>
+
 <h3>Note</h3>
 <ul>
   <li>Folding, or accumulation, is a very general pattern of computation.
diff --git a/doc/reference/list_fold_right.htm b/doc/reference/list_fold_right.htm
index 330b303..206a848 100644
--- a/doc/reference/list_fold_right.htm
+++ b/doc/reference/list_fold_right.htm
@@ -48,6 +48,19 @@ list <code>L</code> (from the right or the end of the list).</p>
   )
 </pre>
 
+<p>For example,</p>
+
+<pre>
+  #define TEST(D,X,P) <a href="cat.htm#BOOST_PP_CAT">BOOST_PP_CAT</a>(P,X)
+  <a href="list_fold_right.htm#BOOST_PP_LIST_FOLD_RIGHT">BOOST_PP_LIST_FOLD_RIGHT</a>(TEST,_,<a href="tuple_to_list.htm#BOOST_PP_TUPLE_TO_LIST">BOOST_PP_TUPLE_TO_LIST</a>(3,(A,B,C)))
+</pre>
+
+<p>expands to:</p>
+
+<pre>
+  _CBA
+</pre>
+
 <h3>Uses</h3>
 <ul>
   <li><a href="while.htm#BOOST_PP_WHILE">BOOST_PP_WHILE</a>() (see for explanation of the D parameter)</li>
diff --git a/doc/reference/list_for_each.htm b/doc/reference/list_for_each.htm
index 39d184b..c7f0b01 100644
--- a/doc/reference/list_for_each.htm
+++ b/doc/reference/list_for_each.htm
@@ -39,6 +39,19 @@
   F(R,P,<a href="list_at.htm#BOOST_PP_LIST_AT">BOOST_PP_LIST_AT</a>(L,<a href="dec.htm#BOOST_PP_DEC">BOOST_PP_DEC</a>(<a href="list_size.htm#BOOST_PP_LIST_SIZE">BOOST_PP_LIST_SIZE</a>(L))))
 </pre>
 
+<p>For example,</p>
+
+<pre>
+  #define TEST(R,P,X) <a href="cat.htm#BOOST_PP_CAT">BOOST_PP_CAT</a>(P,X)();
+  <a href="list_for_each.htm#BOOST_PP_LIST_FOR_EACH">BOOST_PP_LIST_FOR_EACH</a>(TEST,prefix_,<a href="tuple_to_list.htm#BOOST_PP_TUPLE_TO_LIST">BOOST_PP_TUPLE_TO_LIST</a>(3,(A,B,C)))
+</pre>
+
+<p>expands to:</p>
+
+<pre>
+  prefix_A(); prefix_B(); prefix_C();
+</pre>
+
 <h3>Example</h3>
 <ul>
   <li><a href="../../example/catch_builtin.cpp">catch_builtin.cpp</a></li>
diff --git a/doc/reference/list_for_each_i.htm b/doc/reference/list_for_each_i.htm
index 77138d8..9383793 100644
--- a/doc/reference/list_for_each_i.htm
+++ b/doc/reference/list_for_each_i.htm
@@ -39,6 +39,19 @@
   F(R,P,<a href="dec.htm#BOOST_PP_DEC">BOOST_PP_DEC</a>(<a href="list_size.htm#BOOST_PP_LIST_SIZE">BOOST_PP_LIST_SIZE</a>(L)),<a href="list_at.htm#BOOST_PP_LIST_AT">BOOST_PP_LIST_AT</a>(L,<a href="dec.htm#BOOST_PP_DEC">BOOST_PP_DEC</a>(<a href="list_size.htm#BOOST_PP_LIST_SIZE">BOOST_PP_LIST_SIZE</a>(L))))
 </pre>
 
+<p>For example,</p>
+
+<pre>
+  #define TEST(R,P,I,X) <a href="cat.htm#BOOST_PP_CAT">BOOST_PP_CAT</a>(P,X)(I);
+  <a href="list_for_each_i.htm#BOOST_PP_LIST_FOR_EACH_I">BOOST_PP_LIST_FOR_EACH_I</a>(TEST,prefix_,<a href="tuple_to_list.htm#BOOST_PP_TUPLE_TO_LIST">BOOST_PP_TUPLE_TO_LIST</a>(3,(A,B,C)))
+</pre>
+
+<p>expands to:</p>
+
+<pre>
+  prefix_A(0); prefix_B(1); prefix_C(2);
+</pre>
+
 <h3>Uses</h3>
 <ul>
   <li><a href="for.htm#BOOST_PP_FOR">BOOST_PP_FOR</a>() (see for explanation of the R parameter)</li>
diff --git a/doc/reference/list_for_each_product.htm b/doc/reference/list_for_each_product.htm
index d9e6fa7..d1bfba9 100644
--- a/doc/reference/list_for_each_product.htm
+++ b/doc/reference/list_for_each_product.htm
@@ -33,6 +33,25 @@ cartesian product of the lists of the <code>N</code>-tuple <code>T_OF_L</code>.<
 <p>This macro is useful for generating code to avoid combinatorial
 explosion.</p>
 
+<p>For example,</p>
+
+<pre>
+  #define TEST(R,X) X
+  <a href="list_for_each_product.htm#BOOST_PP_LIST_FOR_EACH_PRODUCT">BOOST_PP_LIST_FOR_EACH_PRODUCT</a>
+  ( TEST
+  , 2
+  , ( <a href="tuple_to_list.htm#BOOST_PP_TUPLE_TO_LIST">BOOST_PP_TUPLE_TO_LIST</a>(3,(A,B,C))
+    , <a href="tuple_to_list.htm#BOOST_PP_TUPLE_TO_LIST">BOOST_PP_TUPLE_TO_LIST</a>(2,(1,2))
+    )
+  )
+</pre>
+
+<p>expands to:</p>
+
+<pre>
+  (A,1) (A,2) (B,1) (B,2) (C,1) (C,2) 
+</pre>
+
 <h3>Example</h3>
 <ul>
   <li><a href="../../example/is_integral.cpp">is_integral.cpp</a></li>
diff --git a/doc/reference/logical_bool.htm b/doc/reference/logical_bool.htm
index 5376943..80fcbf6 100644
--- a/doc/reference/logical_bool.htm
+++ b/doc/reference/logical_bool.htm
@@ -29,6 +29,8 @@
 <h2><a name="BOOST_PP_BOOL">#define BOOST_PP_BOOL</a>(X)</h2>
  <p>Expands to <code>0</code> if <code>X == 0</code> and <code>1</code> if <code>X != 0</code>.</p>
 
+<p>For example, <code><a href="logical_bool.htm#BOOST_PP_BOOL">BOOST_PP_BOOL</a>(3)</code> expands to <code>1</code>.</p>
+
 <hr>
 
 <h2><a name="BOOST_PREPROCESSOR_BOOL">#define BOOST_PREPROCESSOR_BOOL</a>(X)</h2>
diff --git a/doc/reference/repeat.htm b/doc/reference/repeat.htm
index 7c1066f..24ef886 100644
--- a/doc/reference/repeat.htm
+++ b/doc/reference/repeat.htm
@@ -35,6 +35,19 @@
   M(0,P) M(1,P) ... M(<a href="dec.htm#BOOST_PP_DEC">BOOST_PP_DEC</a>(N),P)
 </pre>
 
+<p>For example,</p>
+
+<pre>
+  #define TEST(I,P) P(I);
+  <a href="repeat.htm#BOOST_PP_REPEAT">BOOST_PP_REPEAT</a>(3,TEST,X)
+</pre>
+
+<p>expands to:</p>
+
+<pre>
+  X(0); X(1); X(2);
+</pre>
+
 <h3>2D and 3D repetition</h3>
 
 <p>2D and 3D repetition are supported with the <a href="repeat_2nd.htm#BOOST_PP_REPEAT_2ND">BOOST_PP_REPEAT_2ND</a>() and
diff --git a/doc/reference/stringize.htm b/doc/reference/stringize.htm
index e171032..8832034 100644
--- a/doc/reference/stringize.htm
+++ b/doc/reference/stringize.htm
@@ -29,6 +29,8 @@
 <h2><a name="BOOST_PP_STRINGIZE">#define BOOST_PP_STRINGIZE</a>(X)</h2>
  <p>Stringizes <code>X</code> after it is macro expanded.</p>
 
+<p>For example, <code><a href="stringize.htm#BOOST_PP_STRINGIZE">BOOST_PP_STRINGIZE</a>(<a href="cat.htm#BOOST_PP_CAT">BOOST_PP_CAT</a>(a,b))</code> expands to <code>"ab"</code>.</p>
+
 <h3>Example</h3>
 <ul>
   <li><a href="../../example/note.c">note.c</a></li>
diff --git a/doc/reference/while.htm b/doc/reference/while.htm
index 3f7a1c7..c1fd689 100644
--- a/doc/reference/while.htm
+++ b/doc/reference/while.htm
@@ -37,6 +37,20 @@
 
 <p>The depth of iteration is determined by <code>C(D,X)</code>.</p>
 
+<p>For example,</p>
+
+<pre>
+  #define C(D,X) <a href="comparison_less.htm#BOOST_PP_LESS_D">BOOST_PP_LESS_D</a>(D,<a href="tuple_elem.htm#BOOST_PP_TUPLE_ELEM">BOOST_PP_TUPLE_ELEM</a>(2,0,X),<a href="tuple_elem.htm#BOOST_PP_TUPLE_ELEM">BOOST_PP_TUPLE_ELEM</a>(2,1,X))
+  #define F(D,X) (<a href="inc.htm#BOOST_PP_INC">BOOST_PP_INC</a>(<a href="tuple_elem.htm#BOOST_PP_TUPLE_ELEM">BOOST_PP_TUPLE_ELEM</a>(2,0,X)),<a href="tuple_elem.htm#BOOST_PP_TUPLE_ELEM">BOOST_PP_TUPLE_ELEM</a>(2,1,X))
+  <a href="while.htm#BOOST_PP_WHILE">BOOST_PP_WHILE</a>(C,F,(0,3))
+</pre>
+
+<p>expands to:</p>
+
+<pre>
+  (3,3)
+</pre>
+
 <h3>Legend</h3>
 <ul>
   <li><b>X</b> is the current state of iteration. The state is usually a tuple.</li>
diff --git a/include/boost/preprocessor/for.hpp b/include/boost/preprocessor/for.hpp
index 4a91e76..ae0a93f 100644
--- a/include/boost/preprocessor/for.hpp
+++ b/include/boost/preprocessor/for.hpp
@@ -27,6 +27,21 @@
 
 <p>The length of the sequence is determined by <code>C(R,X)</code>.</p>
 
+<p>For example,</p>
+
+<pre>
+  #define C(R,X) BOOST_PP_LESS(BOOST_PP_TUPLE_ELEM(2,0,X),BOOST_PP_TUPLE_ELEM(2,1,X))
+  #define F(R,X) (BOOST_PP_INC(BOOST_PP_TUPLE_ELEM(2,0,X)),BOOST_PP_TUPLE_ELEM(2,1,X))
+  #define I(R,X) BOOST_PP_TUPLE_ELEM(2,0,X)
+  BOOST_PP_FOR((0,3),C,F,I)
+</pre>
+
+<p>expands to:</p>
+
+<pre>
+  0 1 2
+</pre>
+
 <h3>Legend</h3>
 <ul>
   <li><b>X</b> is the current state of iteration. The state is usually a tuple.</li>
@@ -44,21 +59,6 @@
       by the C++ preprocessor.</li>
 </ul>
 
-<p>For example,</p>
-
-<pre>
-  #define C(R,X) BOOST_PP_LESS(BOOST_PP_TUPLE_ELEM(2,0,X),BOOST_PP_TUPLE_ELEM(2,1,X))
-  #define F(R,X) (BOOST_PP_INC(BOOST_PP_TUPLE_ELEM(2,0,X)),BOOST_PP_TUPLE_ELEM(2,1,X))
-  #define I(R,X) BOOST_PP_TUPLE_ELEM(2,0,X)
-  BOOST_PP_FOR((0,3),C,F,I)
-</pre>
-
-<p>expands to:</p>
-
-<pre>
-  0 1 2
-</pre>
-
 <h3>BOOST_PP_REPEAT() vs BOOST_PP_FOR()</h3>
 
 <p>BOOST_PP_FOR() is a generalization of BOOST_PP_REPEAT(). This means that
diff --git a/include/boost/preprocessor/list/fold_left.hpp b/include/boost/preprocessor/list/fold_left.hpp
index 1d4cb69..6c92a7f 100644
--- a/include/boost/preprocessor/list/fold_left.hpp
+++ b/include/boost/preprocessor/list/fold_left.hpp
@@ -33,7 +33,7 @@ list <code>L</code> (from the left or the start of the list).</p>
 
 <pre>
   #define TEST(D,P,X) BOOST_PP_CAT(P,X)
-  BOOST_PP_FOLD_LEFT(TEST,_,BOOST_PP_TUPLE_TO_LIST(3,(A,B,C)))
+  BOOST_PP_LIST_FOLD_LEFT(TEST,_,BOOST_PP_TUPLE_TO_LIST(3,(A,B,C)))
 </pre>
 
 <p>expands to:</p>
diff --git a/include/boost/preprocessor/list/fold_right.hpp b/include/boost/preprocessor/list/fold_right.hpp
index 7f137b7..74ae965 100644
--- a/include/boost/preprocessor/list/fold_right.hpp
+++ b/include/boost/preprocessor/list/fold_right.hpp
@@ -36,6 +36,19 @@ list <code>L</code> (from the right or the end of the list).</p>
   )
 </pre>
 
+<p>For example,</p>
+
+<pre>
+  #define TEST(D,X,P) BOOST_PP_CAT(P,X)
+  BOOST_PP_LIST_FOLD_RIGHT(TEST,_,BOOST_PP_TUPLE_TO_LIST(3,(A,B,C)))
+</pre>
+
+<p>expands to:</p>
+
+<pre>
+  _CBA
+</pre>
+
 <h3>Uses</h3>
 <ul>
   <li>BOOST_PP_WHILE() (see for explanation of the D parameter)</li>
diff --git a/include/boost/preprocessor/list/for_each.hpp b/include/boost/preprocessor/list/for_each.hpp
index 0476e75..4ef7e89 100644
--- a/include/boost/preprocessor/list/for_each.hpp
+++ b/include/boost/preprocessor/list/for_each.hpp
@@ -27,6 +27,19 @@ BOOST_PP_LIST_SIZE(L)[.</p>
   F(R,P,BOOST_PP_LIST_AT(L,BOOST_PP_DEC(BOOST_PP_LIST_SIZE(L))))
 </pre>
 
+<p>For example,</p>
+
+<pre>
+  #define TEST(R,P,X) BOOST_PP_CAT(P,X)();
+  BOOST_PP_LIST_FOR_EACH(TEST,prefix_,BOOST_PP_TUPLE_TO_LIST(3,(A,B,C)))
+</pre>
+
+<p>expands to:</p>
+
+<pre>
+  prefix_A(); prefix_B(); prefix_C();
+</pre>
+
 <h3>Example</h3>
 <ul>
   <li><a href="../../example/catch_builtin.cpp">catch_builtin.cpp</a></li>
diff --git a/include/boost/preprocessor/list/for_each_i.hpp b/include/boost/preprocessor/list/for_each_i.hpp
index 1cda127..72c5e30 100644
--- a/include/boost/preprocessor/list/for_each_i.hpp
+++ b/include/boost/preprocessor/list/for_each_i.hpp
@@ -29,6 +29,19 @@ BOOST_PP_LIST_SIZE(L)[.</p>
   F(R,P,BOOST_PP_DEC(BOOST_PP_LIST_SIZE(L)),BOOST_PP_LIST_AT(L,BOOST_PP_DEC(BOOST_PP_LIST_SIZE(L))))
 </pre>
 
+<p>For example,</p>
+
+<pre>
+  #define TEST(R,P,I,X) BOOST_PP_CAT(P,X)(I);
+  BOOST_PP_LIST_FOR_EACH_I(TEST,prefix_,BOOST_PP_TUPLE_TO_LIST(3,(A,B,C)))
+</pre>
+
+<p>expands to:</p>
+
+<pre>
+  prefix_A(0); prefix_B(1); prefix_C(2);
+</pre>
+
 <h3>Uses</h3>
 <ul>
   <li>BOOST_PP_FOR() (see for explanation of the R parameter)</li>
diff --git a/include/boost/preprocessor/list/for_each_product.hpp b/include/boost/preprocessor/list/for_each_product.hpp
index 1649b4d..ad0361b 100644
--- a/include/boost/preprocessor/list/for_each_product.hpp
+++ b/include/boost/preprocessor/list/for_each_product.hpp
@@ -25,6 +25,25 @@ cartesian product of the lists of the <code>N</code>-tuple <code>T_OF_L</code>.<
 <p>This macro is useful for generating code to avoid combinatorial
 explosion.</p>
 
+<p>For example,</p>
+
+<pre>
+  #define TEST(R,X) X
+  BOOST_PP_LIST_FOR_EACH_PRODUCT
+  ( TEST
+  , 2
+  , ( BOOST_PP_TUPLE_TO_LIST(3,(A,B,C))
+    , BOOST_PP_TUPLE_TO_LIST(2,(1,2))
+    )
+  )
+</pre>
+
+<p>expands to:</p>
+
+<pre>
+  (A,1) (A,2) (B,1) (B,2) (C,1) (C,2) 
+</pre>
+
 <h3>Example</h3>
 <ul>
   <li><a href="../../example/is_integral.cpp">is_integral.cpp</a></li>
diff --git a/include/boost/preprocessor/while.hpp b/include/boost/preprocessor/while.hpp
index 76aad85..e4f2689 100644
--- a/include/boost/preprocessor/while.hpp
+++ b/include/boost/preprocessor/while.hpp
@@ -26,6 +26,20 @@
 
 <p>The depth of iteration is determined by <code>C(D,X)</code>.</p>
 
+<p>For example,</p>
+
+<pre>
+  #define C(D,X) BOOST_PP_LESS_D(D,BOOST_PP_TUPLE_ELEM(2,0,X),BOOST_PP_TUPLE_ELEM(2,1,X))
+  #define F(D,X) (BOOST_PP_INC(BOOST_PP_TUPLE_ELEM(2,0,X)),BOOST_PP_TUPLE_ELEM(2,1,X))
+  BOOST_PP_WHILE(C,F,(0,3))
+</pre>
+
+<p>expands to:</p>
+
+<pre>
+  (3,3)
+</pre>
+
 <h3>Legend</h3>
 <ul>
   <li><b>X</b> is the current state of iteration. The state is usually a tuple.</li>