From da66351f86440c298f977ce7f31a7373096ac578 Mon Sep 17 00:00:00 2001
From: Vesa Karvonen <vesa.karvonen@housemarque.fi>
Date: Sat, 9 Mar 2002 08:57:33 +0000
Subject: [PATCH] Docs updates

[SVN r13142]
---
 doc/reference/if.htm                                 | 3 +--
 doc/reference/list_filter.htm                        | 1 +
 doc/reference/list_fold_left.htm                     | 2 +-
 doc/reference/list_fold_left_2nd.htm                 | 8 +-------
 doc/reference/list_fold_right.htm                    | 1 +
 doc/reference/list_fold_right_2nd.htm                | 8 +-------
 doc/reference/list_for_each.htm                      | 3 ++-
 doc/reference/list_for_each_i.htm                    | 2 +-
 doc/reference/list_for_each_product.htm              | 2 +-
 doc/reference/list_transform.htm                     | 1 +
 include/boost/preprocessor/if.hpp                    | 3 +--
 include/boost/preprocessor/list/filter.hpp           | 1 +
 include/boost/preprocessor/list/fold_left.hpp        | 2 +-
 include/boost/preprocessor/list/fold_left_2nd.hpp    | 8 +-------
 include/boost/preprocessor/list/fold_right.hpp       | 1 +
 include/boost/preprocessor/list/fold_right_2nd.hpp   | 8 +-------
 include/boost/preprocessor/list/for_each.hpp         | 3 ++-
 include/boost/preprocessor/list/for_each_i.hpp       | 2 +-
 include/boost/preprocessor/list/for_each_product.hpp | 2 +-
 include/boost/preprocessor/list/transform.hpp        | 1 +
 20 files changed, 22 insertions(+), 40 deletions(-)

diff --git a/doc/reference/if.htm b/doc/reference/if.htm
index 6e39848..dd0e053 100644
--- a/doc/reference/if.htm
+++ b/doc/reference/if.htm
@@ -30,8 +30,7 @@
  <p>Expands to <code>T</code> if <code>C != 0</code> and <code>E</code> if
 <code>C == 0</code>.</p>
 
-<p><a href="if.htm#BOOST_PP_IF">BOOST_PP_IF</a>() enables convenient generation of lists using
-<a href="repeat.htm#BOOST_PP_REPEAT">BOOST_PP_REPEAT</a>().</p>
+<p>For example, <code><a href="if.htm#BOOST_PP_IF">BOOST_PP_IF</a>(0,1,2)</code> expands to <code>2</code>.</p>
 
 <h3>Test</h3>
 <ul>
diff --git a/doc/reference/list_filter.htm b/doc/reference/list_filter.htm
index 789c7d2..0672749 100644
--- a/doc/reference/list_filter.htm
+++ b/doc/reference/list_filter.htm
@@ -44,6 +44,7 @@ for which <code>F(D,P,X)</code> is true.</p>
 
 <h3>Uses</h3>
 <ul>
+  <li><a href="while.htm#BOOST_PP_WHILE">BOOST_PP_WHILE</a>() (see for explanation of the D parameter)</li>
   <li><a href="list_fold_right.htm#BOOST_PP_LIST_FOLD_RIGHT">BOOST_PP_LIST_FOLD_RIGHT</a>()</li>
 </ul>
 
diff --git a/doc/reference/list_fold_left.htm b/doc/reference/list_fold_left.htm
index 7de365d..2b2f1c2 100644
--- a/doc/reference/list_fold_left.htm
+++ b/doc/reference/list_fold_left.htm
@@ -53,7 +53,7 @@ list <code>L</code> (from the left or the start of the list).</p>
 
 <h3>Uses</h3>
 <ul>
-  <li><a href="while.htm#BOOST_PP_WHILE">BOOST_PP_WHILE</a>()</li>
+  <li><a href="while.htm#BOOST_PP_WHILE">BOOST_PP_WHILE</a>() (see for explanation of the D parameter)</li>
 </ul>
 
 <h3>Test</h3>
diff --git a/doc/reference/list_fold_left_2nd.htm b/doc/reference/list_fold_left_2nd.htm
index 398b087..c46f73d 100644
--- a/doc/reference/list_fold_left_2nd.htm
+++ b/doc/reference/list_fold_left_2nd.htm
@@ -27,13 +27,7 @@
 <hr>
 
 <h2><a name="BOOST_PP_LIST_FOLD_LEFT_2ND">#define BOOST_PP_LIST_FOLD_LEFT_2ND</a>(F,P,L)</h2>
- <p>Same as <a href="list_fold_left.htm#BOOST_PP_LIST_FOLD_LEFT">BOOST_PP_LIST_FOLD_LEFT</a>(), but implemented independently.</p>
-
-<h3>Uses</h3>
-<ul>
-  <li><a href="while.htm#BOOST_PP_WHILE">BOOST_PP_WHILE</a>()</li>
-</ul>
-
+ <p>Same as <a href="list_fold_left.htm#BOOST_PP_LIST_FOLD_LEFT">BOOST_PP_LIST_FOLD_LEFT</a>(), but implemented independently.</p> 
 <hr>
 
 <h2><a name="BOOST_PP_LIST_FOLD_LEFT_2ND_D">#define BOOST_PP_LIST_FOLD_LEFT_2ND_D</a>(D,F,P,L)</h2>
diff --git a/doc/reference/list_fold_right.htm b/doc/reference/list_fold_right.htm
index 52ce289..330b303 100644
--- a/doc/reference/list_fold_right.htm
+++ b/doc/reference/list_fold_right.htm
@@ -50,6 +50,7 @@ list <code>L</code> (from the right or the end of the list).</p>
 
 <h3>Uses</h3>
 <ul>
+  <li><a href="while.htm#BOOST_PP_WHILE">BOOST_PP_WHILE</a>() (see for explanation of the D parameter)</li>
   <li><a href="list_fold_left.htm#BOOST_PP_LIST_FOLD_LEFT">BOOST_PP_LIST_FOLD_LEFT</a>()</li>
 </ul>
 
diff --git a/doc/reference/list_fold_right_2nd.htm b/doc/reference/list_fold_right_2nd.htm
index 970c6bb..6f0715d 100644
--- a/doc/reference/list_fold_right_2nd.htm
+++ b/doc/reference/list_fold_right_2nd.htm
@@ -27,13 +27,7 @@
 <hr>
 
 <h2><a name="BOOST_PP_LIST_FOLD_RIGHT_2ND">#define BOOST_PP_LIST_FOLD_RIGHT_2ND</a>(F,L,P)</h2>
- <p>Same as <a href="list_fold_right.htm#BOOST_PP_LIST_FOLD_RIGHT">BOOST_PP_LIST_FOLD_RIGHT</a>(), but implemented independently.</p>
-
-<h3>Uses</h3>
-<ul>
-  <li><a href="list_fold_left_2nd.htm#BOOST_PP_LIST_FOLD_LEFT_2ND">BOOST_PP_LIST_FOLD_LEFT_2ND</a>()</li>
-</ul>
-
+ <p>Same as <a href="list_fold_right.htm#BOOST_PP_LIST_FOLD_RIGHT">BOOST_PP_LIST_FOLD_RIGHT</a>(), but implemented independently.</p> 
 <hr>
 
 <h2><a name="BOOST_PP_LIST_FOLD_RIGHT_2ND_D">#define BOOST_PP_LIST_FOLD_RIGHT_2ND_D</a>(D,F,L,P)</h2>
diff --git a/doc/reference/list_for_each.htm b/doc/reference/list_for_each.htm
index 40161d3..39d184b 100644
--- a/doc/reference/list_for_each.htm
+++ b/doc/reference/list_for_each.htm
@@ -46,7 +46,8 @@
 
 <h3>Uses</h3>
 <ul>
-  <li><a href="list_for_each_i.htm#BOOST_PP_LIST_FOR_EACH_I">BOOST_PP_LIST_FOR_EACH_I</a>()</li>
+  <li><a href="for.htm#BOOST_PP_FOR">BOOST_PP_FOR</a>() (see for explanation of the R parameter)</li>
+  <li><a href="list_for_each_i.htm#BOOST_PP_LIST_FOR_EACH_I">BOOST_PP_LIST_FOR_EACH_I</a>() </li>
 </ul>
 
 <h3>Test</h3>
diff --git a/doc/reference/list_for_each_i.htm b/doc/reference/list_for_each_i.htm
index e6458a2..77138d8 100644
--- a/doc/reference/list_for_each_i.htm
+++ b/doc/reference/list_for_each_i.htm
@@ -41,7 +41,7 @@
 
 <h3>Uses</h3>
 <ul>
-  <li><a href="for.htm#BOOST_PP_FOR">BOOST_PP_FOR</a>()</li>
+  <li><a href="for.htm#BOOST_PP_FOR">BOOST_PP_FOR</a>() (see for explanation of the R parameter)</li>
 </ul>
 
 <hr>
diff --git a/doc/reference/list_for_each_product.htm b/doc/reference/list_for_each_product.htm
index 08857a0..d9e6fa7 100644
--- a/doc/reference/list_for_each_product.htm
+++ b/doc/reference/list_for_each_product.htm
@@ -41,7 +41,7 @@ explosion.</p>
 
 <h3>Uses</h3>
 <ul>
-  <li><a href="for.htm#BOOST_PP_FOR">BOOST_PP_FOR</a>()</li>
+  <li><a href="for.htm#BOOST_PP_FOR">BOOST_PP_FOR</a>() (see for explanation of the R parameter)</li>
 </ul>
 
 <h3>Test</h3>
diff --git a/doc/reference/list_transform.htm b/doc/reference/list_transform.htm
index eb6f823..eccc436 100644
--- a/doc/reference/list_transform.htm
+++ b/doc/reference/list_transform.htm
@@ -54,6 +54,7 @@ of the list producing a new list.</p>
 
 <h3>Uses</h3>
 <ul>
+  <li><a href="while.htm#BOOST_PP_WHILE">BOOST_PP_WHILE</a>() (see for explanation of the D parameter)</li>
   <li><a href="list_fold_right.htm#BOOST_PP_LIST_FOLD_RIGHT">BOOST_PP_LIST_FOLD_RIGHT</a>()</li>
 </ul>
 
diff --git a/include/boost/preprocessor/if.hpp b/include/boost/preprocessor/if.hpp
index 8fd2915..1bce470 100644
--- a/include/boost/preprocessor/if.hpp
+++ b/include/boost/preprocessor/if.hpp
@@ -19,8 +19,7 @@
 /** <p>Expands to <code>T</code> if <code>C != 0</code> and <code>E</code> if
 <code>C == 0</code>.</p>
 
-<p>BOOST_PP_IF() enables convenient generation of lists using
-BOOST_PP_REPEAT().</p>
+<p>For example, <code>BOOST_PP_IF(0,1,2)</code> expands to <code>2</code>.</p>
 
 <h3>Test</h3>
 <ul>
diff --git a/include/boost/preprocessor/list/filter.hpp b/include/boost/preprocessor/list/filter.hpp
index 656d43f..e32c485 100644
--- a/include/boost/preprocessor/list/filter.hpp
+++ b/include/boost/preprocessor/list/filter.hpp
@@ -32,6 +32,7 @@ for which <code>F(D,P,X)</code> is true.</p>
 
 <h3>Uses</h3>
 <ul>
+  <li>BOOST_PP_WHILE() (see for explanation of the D parameter)</li>
   <li>BOOST_PP_LIST_FOLD_RIGHT()</li>
 </ul>
 
diff --git a/include/boost/preprocessor/list/fold_left.hpp b/include/boost/preprocessor/list/fold_left.hpp
index 12481ca..cad6ff1 100644
--- a/include/boost/preprocessor/list/fold_left.hpp
+++ b/include/boost/preprocessor/list/fold_left.hpp
@@ -42,7 +42,7 @@ list <code>L</code> (from the left or the start of the list).</p>
 
 <h3>Uses</h3>
 <ul>
-  <li>BOOST_PP_WHILE()</li>
+  <li>BOOST_PP_WHILE() (see for explanation of the D parameter)</li>
 </ul>
 
 <h3>Test</h3>
diff --git a/include/boost/preprocessor/list/fold_left_2nd.hpp b/include/boost/preprocessor/list/fold_left_2nd.hpp
index 2879e85..0ebb190 100644
--- a/include/boost/preprocessor/list/fold_left_2nd.hpp
+++ b/include/boost/preprocessor/list/fold_left_2nd.hpp
@@ -16,13 +16,7 @@
 #include <boost/preprocessor/list/adt.hpp>
 #include <boost/preprocessor/while.hpp>
 
-/** <p>Same as BOOST_PP_LIST_FOLD_LEFT(), but implemented independently.</p>
-
-<h3>Uses</h3>
-<ul>
-  <li>BOOST_PP_WHILE()</li>
-</ul>
-*/
+/** <p>Same as BOOST_PP_LIST_FOLD_LEFT(), but implemented independently.</p> */
 #define BOOST_PP_LIST_FOLD_LEFT_2ND(F,P,L) BOOST_PP_LIST_FOLD_LEFT_2ND_D(0,F,P,L)
 
 /** <p>Can be used inside BOOST_PP_WHILE().</p> */
diff --git a/include/boost/preprocessor/list/fold_right.hpp b/include/boost/preprocessor/list/fold_right.hpp
index 5956bbe..340dab1 100644
--- a/include/boost/preprocessor/list/fold_right.hpp
+++ b/include/boost/preprocessor/list/fold_right.hpp
@@ -38,6 +38,7 @@ list <code>L</code> (from the right or the end of the list).</p>
 
 <h3>Uses</h3>
 <ul>
+  <li>BOOST_PP_WHILE() (see for explanation of the D parameter)</li>
   <li>BOOST_PP_LIST_FOLD_LEFT()</li>
 </ul>
 
diff --git a/include/boost/preprocessor/list/fold_right_2nd.hpp b/include/boost/preprocessor/list/fold_right_2nd.hpp
index ecb1a85..482d098 100644
--- a/include/boost/preprocessor/list/fold_right_2nd.hpp
+++ b/include/boost/preprocessor/list/fold_right_2nd.hpp
@@ -16,13 +16,7 @@
 #include <boost/preprocessor/list/fold_left_2nd.hpp>
 #include <boost/preprocessor/list/reverse.hpp>
 
-/** <p>Same as BOOST_PP_LIST_FOLD_RIGHT(), but implemented independently.</p>
-
-<h3>Uses</h3>
-<ul>
-  <li>BOOST_PP_LIST_FOLD_LEFT_2ND()</li>
-</ul>
-*/
+/** <p>Same as BOOST_PP_LIST_FOLD_RIGHT(), but implemented independently.</p> */
 #define BOOST_PP_LIST_FOLD_RIGHT_2ND(F,L,P) BOOST_PP_LIST_FOLD_RIGHT_2ND_D(0,F,L,P)
 
 /** <p>Can be used inside BOOST_PP_WHILE().</p> */
diff --git a/include/boost/preprocessor/list/for_each.hpp b/include/boost/preprocessor/list/for_each.hpp
index 796ff20..0476e75 100644
--- a/include/boost/preprocessor/list/for_each.hpp
+++ b/include/boost/preprocessor/list/for_each.hpp
@@ -34,7 +34,8 @@ BOOST_PP_LIST_SIZE(L)[.</p>
 
 <h3>Uses</h3>
 <ul>
-  <li>BOOST_PP_LIST_FOR_EACH_I()</li>
+  <li>BOOST_PP_FOR() (see for explanation of the R parameter)</li>
+  <li>BOOST_PP_LIST_FOR_EACH_I() </li>
 </ul>
 
 <h3>Test</h3>
diff --git a/include/boost/preprocessor/list/for_each_i.hpp b/include/boost/preprocessor/list/for_each_i.hpp
index cb64ecb..1cda127 100644
--- a/include/boost/preprocessor/list/for_each_i.hpp
+++ b/include/boost/preprocessor/list/for_each_i.hpp
@@ -31,7 +31,7 @@ BOOST_PP_LIST_SIZE(L)[.</p>
 
 <h3>Uses</h3>
 <ul>
-  <li>BOOST_PP_FOR()</li>
+  <li>BOOST_PP_FOR() (see for explanation of the R parameter)</li>
 </ul>
 */
 #define BOOST_PP_LIST_FOR_EACH_I(F,P,L) BOOST_PP_LIST_FOR_EACH_I_R(0,F,P,L)
diff --git a/include/boost/preprocessor/list/for_each_product.hpp b/include/boost/preprocessor/list/for_each_product.hpp
index 918480e..7d7feab 100644
--- a/include/boost/preprocessor/list/for_each_product.hpp
+++ b/include/boost/preprocessor/list/for_each_product.hpp
@@ -33,7 +33,7 @@ explosion.</p>
 
 <h3>Uses</h3>
 <ul>
-  <li>BOOST_PP_FOR()</li>
+  <li>BOOST_PP_FOR() (see for explanation of the R parameter)</li>
 </ul>
 
 <h3>Test</h3>
diff --git a/include/boost/preprocessor/list/transform.hpp b/include/boost/preprocessor/list/transform.hpp
index 2731f79..34b66db 100644
--- a/include/boost/preprocessor/list/transform.hpp
+++ b/include/boost/preprocessor/list/transform.hpp
@@ -42,6 +42,7 @@ of the list producing a new list.</p>
 
 <h3>Uses</h3>
 <ul>
+  <li>BOOST_PP_WHILE() (see for explanation of the D parameter)</li>
   <li>BOOST_PP_LIST_FOLD_RIGHT()</li>
 </ul>