From d791b3f756f735474ea0915dcc4610df9ecf2f6e Mon Sep 17 00:00:00 2001
From: Vesa Karvonen <vesa.karvonen@housemarque.fi>
Date: Fri, 1 Feb 2002 11:40:52 +0000
Subject: [PATCH] Working on docs

[SVN r12619]
---
 include/boost/preprocessor/list/adt.hpp       | 43 ++++---------------
 include/boost/preprocessor/list/fold_left.hpp |  7 ++-
 .../preprocessor/list/for_each_product.hpp    |  4 +-
 include/boost/preprocessor/list/to_tuple.hpp  |  7 ++-
 4 files changed, 22 insertions(+), 39 deletions(-)

diff --git a/include/boost/preprocessor/list/adt.hpp b/include/boost/preprocessor/list/adt.hpp
index 108086b..56475d0 100644
--- a/include/boost/preprocessor/list/adt.hpp
+++ b/include/boost/preprocessor/list/adt.hpp
@@ -15,9 +15,12 @@
 
 /** <P>This header defines the fundamental list operations.</P>
 
-<P>NOTE: The internal representation of lists is hidden. Although there
-aren't compelling reasons to change the representation, you should avoid
-writing code that depends on the internal representation details.</P>
+<H3>Note</H3>
+<UL>
+  <LI>The internal representation of lists is hidden. Although there aren't
+      compelling reasons to change the representation, you should avoid
+      writing code that depends on the internal representation details.</P>
+</UL>
 */
 
 #include <boost/preprocessor/tuple/elem.hpp>
@@ -47,35 +50,17 @@ BOOST_PP_LIST_CONS(). For example,</P>
 */
 #define BOOST_PP_LIST_CONS(H,T) (H,T,1)
 
-/** <P>List nil constructor.</P>
-
-<H3>See</H3>
-<UL>
-  <LI>BOOST_PP_LIST_CONS()
-</UL>
-*/
+/** <P>List nil constructor.</P> */
 #define BOOST_PP_LIST_NIL (_,_,0)
 
-/** <P>Expands to 1 if the list is not nil and 0 otherwise.</P>
-
-<H3>See</H3>
-<UL>
-  <LI>BOOST_PP_LIST_IS_NIL()
-</UL>
-*/
+/** <P>Expands to 1 if the list is not nil and 0 otherwise.</P> */
 #if !defined(BOOST_NO_COMPILER_CONFIG) && defined(__MWERKS__) && __MWERKS__ <= 0x2406
 #  define BOOST_PP_LIST_IS_CONS(L) BOOST_PP_TUPLE_ELEM(3,2,L)
 #else
 #  define BOOST_PP_LIST_IS_CONS(L) BOOST_PP_TUPLE3_ELEM2 L
 #endif
 
-/** <P>Expands to 1 if the list is nil and 0 otherwise.</P>
-
-<H3>See</H3>
-<UL>
-  <LI>BOOST_PP_LIST_IS_CONS()
-</UL>
-*/
+/** <P>Expands to 1 if the list is nil and 0 otherwise.</P> */
 #if !defined(BOOST_NO_COMPILER_CONFIG) && defined(__MWERKS__) && __MWERKS__ <= 0x2406
 #  define BOOST_PP_LIST_IS_NIL(L) BOOST_PP_NOT(BOOST_PP_TUPLE_ELEM(3,2,L))
 #else
@@ -91,11 +76,6 @@ BOOST_PP_LIST_CONS(). For example,</P>
 </PRE>
 
 <P>expands to 1.</P>
-
-<H3>See</H3>
-<UL>
-  <LI>BOOST_PP_LIST_REST()
-</UL>
 */
 #if !defined(BOOST_NO_COMPILER_CONFIG) && defined(__MWERKS__) && __MWERKS__ <= 0x2406
 #  define BOOST_PP_LIST_FIRST(L) BOOST_PP_TUPLE_ELEM(3,0,L)
@@ -112,11 +92,6 @@ BOOST_PP_LIST_CONS(). For example,</P>
 </PRE>
 
 <P>expands to a list containing 2, 3, 4 and 5.</P>
-
-<H3>See</H3>
-<UL>
-  <LI>BOOST_PP_LIST_FIRST()
-</UL>
 */
 #if !defined(BOOST_NO_COMPILER_CONFIG) && defined(__MWERKS__) && __MWERKS__ <= 0x2406
 #  define BOOST_PP_LIST_REST(L) BOOST_PP_TUPLE_ELEM(3,1,L)
diff --git a/include/boost/preprocessor/list/fold_left.hpp b/include/boost/preprocessor/list/fold_left.hpp
index 595d346..ae079cf 100644
--- a/include/boost/preprocessor/list/fold_left.hpp
+++ b/include/boost/preprocessor/list/fold_left.hpp
@@ -34,8 +34,11 @@
   )
 </PRE>
 
-<P>Note that folding, or accumulation, is a very general pattern of computation.
-Most list operations can be implemented in terms of folding.</P>
+<H3>Note</H3>
+<UL>
+  <LI>Folding, or accumulation, is a very general pattern of computation.
+      Most list operations can be implemented in terms of folding.
+</UL>
 
 <H3>See</H3>
 <UL>
diff --git a/include/boost/preprocessor/list/for_each_product.hpp b/include/boost/preprocessor/list/for_each_product.hpp
index 7b9cacd..75fef01 100644
--- a/include/boost/preprocessor/list/for_each_product.hpp
+++ b/include/boost/preprocessor/list/for_each_product.hpp
@@ -22,9 +22,11 @@
 
 <P>This macro is useful for generating code to avoid combinatorial explosion.</P>
 
+<H3>Legend</H3>
 <UL>
   <LI><B>LL</B> is a list of lists.
-  <LI><B>X</B> is an element of the cartesian product of the lists LL.
+  <LI><B>X</B> is a list of the elements of an element of the cartesian product of
+      the lists LL.
 </UL>
 
 <H3>Example</H3>
diff --git a/include/boost/preprocessor/list/to_tuple.hpp b/include/boost/preprocessor/list/to_tuple.hpp
index 94f37ba..4cbfb83 100644
--- a/include/boost/preprocessor/list/to_tuple.hpp
+++ b/include/boost/preprocessor/list/to_tuple.hpp
@@ -26,8 +26,11 @@
 
 <P>expands to (A,B,C).</P>
 
-<P>NOTE: The supported size of the list being converted to a tuple is limited by
-BOOST_PP_LIMIT_MAG rather than BOOST_PP_LIMIT_TUPLE.</P>
+<H3>Note</H3>
+<UL>
+  <LI>The supported size of the list being converted to a tuple is limited by
+      BOOST_PP_LIMIT_MAG rather than BOOST_PP_LIMIT_TUPLE.</P>
+</UL>
 
 <H3>Uses</H3>
 <UL>