Working on docs

[SVN r12586]

include/boost/preprocessor/list/adt.hpp

@@ -53,13 +53,15 @@ Both of the above lists contain 5 elements: 1, 2, 3, 4 and 5.
 
 /** List nil constructor.
 
-See BOOST_PP_LIST_CONS().
+<H3>See</H3>
+- BOOST_PP_LIST_CONS()
 */
 #define BOOST_PP_LIST_NIL (_,_,0)
 
 /** Expands to 1 if the list is not nil and 0 otherwise.
 
-See BOOST_PP_LIST_IS_NIL().
+<H3>See</H3>
+- BOOST_PP_LIST_IS_NIL()
 */
 #if !defined(BOOST_NO_COMPILER_CONFIG) && defined(__MWERKS__) && __MWERKS__ <= 0x2406
 #  define BOOST_PP_LIST_IS_CONS(L) BOOST_PP_TUPLE_ELEM(3,2,L)
@@ -69,7 +71,8 @@ See BOOST_PP_LIST_IS_NIL().
 
 /** Expands to 1 if the list is nil and 0 otherwise.
 
-See BOOST_PP_LIST_IS_CONS().
+<H3>See</H3>
+- BOOST_PP_LIST_IS_CONS()
 */
 #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))
@@ -87,7 +90,8 @@ For example,
 
 expands to 1.
 
-See BOOST_PP_LIST_REST().
+<H3>See</H3>
+- BOOST_PP_LIST_REST()
 */
 #if !defined(BOOST_NO_COMPILER_CONFIG) && defined(__MWERKS__) && __MWERKS__ <= 0x2406
 #  define BOOST_PP_LIST_FIRST(L) BOOST_PP_TUPLE_ELEM(3,0,L)
@@ -105,7 +109,8 @@ For example,
 
 expands to a list containing 2, 3, 4 and 5.
 
-See BOOST_PP_LIST_FIRST().
+<H3>See</H3>
+- BOOST_PP_LIST_FIRST()
 */
 #if !defined(BOOST_NO_COMPILER_CONFIG) && defined(__MWERKS__) && __MWERKS__ <= 0x2406
 #  define BOOST_PP_LIST_REST(L) BOOST_PP_TUPLE_ELEM(3,1,L)

include/boost/preprocessor/list/append.hpp

@@ -32,6 +32,9 @@ For example,
 \endverbatim</PRE>
 
 produces a list containing 1, 2, 3 and 4.
+
+<H3>Uses</H3>
+- BOOST_PP_WHILE()
 */
 #define BOOST_PP_LIST_APPEND(L,P) BOOST_PP_LIST_APPEND_D(0,L,P)
 

include/boost/preprocessor/list/at.hpp

@@ -29,6 +29,9 @@ For example,
 \endverbatim</PRE>
 
 expands to B.
+
+<H3>Uses</H3>
+- BOOST_PP_WHILE()
 */
 #define BOOST_PP_LIST_AT(L,I) BOOST_PP_LIST_AT_D(0,L,I)
 

include/boost/preprocessor/list/cat.hpp

@@ -30,6 +30,9 @@ For example,
 \endverbatim</PRE>
 
 expands to 123.
+
+<H3>Uses</H3>
+- BOOST_PP_WHILE()
 */
 #define BOOST_PP_LIST_CAT(L) BOOST_PP_LIST_CAT_D(0,L)
 

include/boost/preprocessor/list/enum.hpp

@@ -34,6 +34,9 @@ expands to:
 <PRE>\verbatim
   A, B, C
 \endverbatim</PRE>
+
+<H3>Uses</H3>
+- BOOST_PP_FOR().
 */
 #define BOOST_PP_LIST_ENUM(L) BOOST_PP_LIST_ENUM_R(0,L)
 

include/boost/preprocessor/list/filter.hpp

@@ -29,6 +29,9 @@ For example,
 \endverbatim</PRE>
 
 expands to a list containing 1 and 3.
+
+<H3>Uses</H3>
+- BOOST_PP_WHILE()
 */
 #define BOOST_PP_LIST_FILTER(F,P,L) BOOST_PP_LIST_FILTER_D(0,F,P,L)
 

include/boost/preprocessor/list/first_n.hpp

@@ -31,6 +31,9 @@ For example,
 \endverbatim</PRE>
 
 expands to a list containing + and -.
+
+<H3>Uses</H3>
+- BOOST_PP_WHILE()
 */
 #define BOOST_PP_LIST_FIRST_N(N,L) BOOST_PP_LIST_FIRST_N_D(0,N,L)
 

include/boost/preprocessor/list/fold_left.hpp

@@ -42,7 +42,11 @@ expands to:
 Note that folding, or accumulation, is a very general pattern of computation.
 Most list operations can be implemented in terms of folding.
 
-See BOOST_PP_LIST_FOLD_RIGHT().
+<H3>See</H3>
+- BOOST_PP_LIST_FOLD_RIGHT()
+
+<H3>Uses</H3>
+- BOOST_PP_WHILE()
 */
 #define BOOST_PP_LIST_FOLD_LEFT(F,P,L) BOOST_PP_LIST_FOLD_LEFT_D(0,F,P,L)
 

include/boost/preprocessor/list/fold_right.hpp

@@ -46,7 +46,11 @@ expands to:
   )
 \endverbatim</PRE>
 
-See BOOST_PP_LIST_FOLD_LEFT().
+<H3>See</H3>
+- BOOST_PP_LIST_FOLD_LEFT()
+
+<H3>Uses</H3>
+- BOOST_PP_WHILE()
 */
 #define BOOST_PP_LIST_FOLD_RIGHT(F,L,P) BOOST_PP_LIST_FOLD_RIGHT_D(0,F,L,P)
 

include/boost/preprocessor/list/for_each.hpp

@@ -32,7 +32,11 @@ In other words, expands to the sequence:
   F(R,P,BOOST_PP_LIST_AT(L,BOOST_PP_DEC(BOOST_PP_LIST_SIZE(L))))
 \endverbatim</PRE>
 
-See BOOST_PP_FOR() for an explanation of the R parameter.
+<H3>Example</H3>
+- <a href="../../example/catch_builtin.cpp">catch_builtin.cpp</a>
+
+<H3>Uses</H3>
+- BOOST_PP_FOR()
 */
 #define BOOST_PP_LIST_FOR_EACH(F,P,L) BOOST_PP_LIST_FOR_EACH_R(0,F,P,L)
 

include/boost/preprocessor/list/for_each_product.hpp

@@ -31,9 +31,12 @@ This macro is useful for generating code to avoid combinatorial explosion.
 
 <B>X</B> is an element of the cartesian product of the lists LL.
 
-<H3>Examples</H3>
+<H3>Example</H3>
 - <a href="../../example/is_integral.cpp">is_integral.cpp</a>
 - <a href="../../example/array_arithmetic.c">array_arithmetic.c</a>
+
+<H3>Uses</H3>
+- BOOST_PP_FOR()
 */
 #define BOOST_PP_LIST_FOR_EACH_PRODUCT(F,P,LL) BOOST_PP_LIST_FOR_EACH_PRODUCT_R(0,F,P,LL)
 

include/boost/preprocessor/list/rest_n.hpp

@@ -31,6 +31,9 @@ For example,
 \endverbatim</PRE>
 
 expands to a list containing * and /.
+
+<H3>Uses</H3>
+- BOOST_PP_WHILE()
 */
 #define BOOST_PP_LIST_REST_N(N,L) BOOST_PP_LIST_REST_N_D(0,N,L)
 

include/boost/preprocessor/list/reverse.hpp

@@ -29,6 +29,9 @@ For example,
 \endverbatim</PRE>
 
 expands to a list containing C, B and A.
+
+<H3>Uses</H3>
+- BOOST_PP_WHILE()
 */
 #define BOOST_PP_LIST_REVERSE(L) BOOST_PP_LIST_REVERSE_D(0,L)
 

include/boost/preprocessor/list/size.hpp

@@ -30,6 +30,9 @@ For example,
 \endverbatim</PRE>
 
 expands to 3.
+
+<H3>Uses</H3>
+- BOOST_PP_WHILE()
 */
 #define BOOST_PP_LIST_SIZE(L) BOOST_PP_LIST_SIZE_D(0,L)
 

include/boost/preprocessor/list/to_tuple.hpp

@@ -33,6 +33,9 @@ expands to (A,B,C).
 
 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.
+
+<H3>Uses</H3>
+- BOOST_PP_FOR()
 */
 #define BOOST_PP_LIST_TO_TUPLE(L) BOOST_PP_LIST_TO_TUPLE_R(0,L)
 

include/boost/preprocessor/list/transform.hpp

@@ -39,6 +39,9 @@ For example,
 \endverbatim</PRE>
 
 expands to a list containing 3 and 4.
+
+<H3>Uses</H3>
+- BOOST_PP_WHILE()
 */
 #define BOOST_PP_LIST_TRANSFORM(F,P,L) BOOST_PP_LIST_TRANSFORM_D(0,F,P,L)