Minor documentation change

[SVN r12397]
This commit is contained in:
Vesa Karvonen
2002-01-21 19:05:49 +00:00
parent 255317ea1b
commit a07e8b26b7
5 changed files with 16 additions and 16 deletions

View File

@ -19,7 +19,7 @@
//! Delays the catenation of L and R. //! Delays the catenation of L and R.
/*! /*!
Example: For example,
<PRE>\verbatim <PRE>\verbatim
#define STATIC_ASSERT(EXPR)\ #define STATIC_ASSERT(EXPR)\
@ -36,7 +36,7 @@ Example:
STATIC_ASSERT(sizeof(int) <= sizeof(long)); STATIC_ASSERT(sizeof(int) <= sizeof(long));
\endverbatim</PRE> \endverbatim</PRE>
The above expands to: expands to:
<PRE>\verbatim <PRE>\verbatim
enum enum

View File

@ -23,14 +23,14 @@
/*! /*!
Designed to be used with BOOST_PP_IF(), when one of the clauses need to be invoked. Designed to be used with BOOST_PP_IF(), when one of the clauses need to be invoked.
Example: For example,
<PRE>\verbatim <PRE>\verbatim
BOOST_PP_IDENTITY(X)() BOOST_PP_IDENTITY(X)()
// ^^ NOTE! // ^^ NOTE!
\endverbatim</PRE> \endverbatim</PRE>
The above expands to: expands to:
<PRE>\verbatim <PRE>\verbatim
X X

View File

@ -19,7 +19,7 @@
//! Delays the stringization of E. //! Delays the stringization of E.
/*! /*!
Example: For example,
<PRE>\verbatim <PRE>\verbatim
#define NOTE(STR)\ #define NOTE(STR)\
@ -30,7 +30,7 @@ Example:
#pragma NOTE("TBD!") #pragma NOTE("TBD!")
\endverbatim</PRE> \endverbatim</PRE>
The above expands to: expands to:
<PRE>\verbatim <PRE>\verbatim
#pragma message("examples.cpp" "(" "20" ") : " "TBD!") #pragma message("examples.cpp" "(" "20" ") : " "TBD!")

View File

@ -22,13 +22,13 @@
BOOST_PP_TUPLE_EAT() is designed to be used with BOOST_PP_IF() like BOOST_PP_TUPLE_EAT() is designed to be used with BOOST_PP_IF() like
BOOST_PP_EMPTY(). BOOST_PP_EMPTY().
For example: For example,
<PRE>\verbatim <PRE>\verbatim
BOOST_PP_IF(0,BOOST_PP_ENUM_PARAMS,BOOST_PP_TUPLE_EAT(2))(10,P) BOOST_PP_IF(0,BOOST_PP_ENUM_PARAMS,BOOST_PP_TUPLE_EAT(2))(10,P)
\endverbatim</PRE> \endverbatim</PRE>
The above expands to nothing. expands to nothing.
*/ */
#define BOOST_PP_TUPLE_EAT(N) BOOST_PP_TUPLE_EAT_DELAY(N) #define BOOST_PP_TUPLE_EAT(N) BOOST_PP_TUPLE_EAT_DELAY(N)

View File

@ -21,6 +21,14 @@
//! Expands to the I:th element of an N-tuple. //! Expands to the I:th element of an N-tuple.
/*! /*!
For example,
<PRE>\verbatim
BOOST_PP_TUPLE_ELEM(2,1,(A,B))
\endverbatim</PRE>
expands to B.
Tuples can be used for representing structured data. Tuples can be used for representing structured data.
Examples of tuples: Examples of tuples:
@ -31,14 +39,6 @@ Examples of tuples:
4-tuple: (A B C, D, EF, 34) 4-tuple: (A B C, D, EF, 34)
\endverbatim</PRE> \endverbatim</PRE>
Example:
<PRE>\verbatim
BOOST_PP_TUPLE_ELEM(2,1,(A,B))
\endverbatim</PRE>
The above expands to B.
See also BOOST_PP_LIMIT_TUPLE. See also BOOST_PP_LIMIT_TUPLE.
*/ */
#define BOOST_PP_TUPLE_ELEM(N,I,T) BOOST_PP_TUPLE_ELEM_DELAY(N,I,T) #define BOOST_PP_TUPLE_ELEM(N,I,T) BOOST_PP_TUPLE_ELEM_DELAY(N,I,T)