From a07e8b26b79a7dbbc3e3291f11a8b5f7bb6450d8 Mon Sep 17 00:00:00 2001 From: Vesa Karvonen Date: Mon, 21 Jan 2002 19:05:49 +0000 Subject: [PATCH] Minor documentation change [SVN r12397] --- include/boost/preprocessor/cat.hpp | 4 ++-- include/boost/preprocessor/identity.hpp | 4 ++-- include/boost/preprocessor/stringize.hpp | 4 ++-- include/boost/preprocessor/tuple/eat.hpp | 4 ++-- include/boost/preprocessor/tuple/elem.hpp | 16 ++++++++-------- 5 files changed, 16 insertions(+), 16 deletions(-) diff --git a/include/boost/preprocessor/cat.hpp b/include/boost/preprocessor/cat.hpp index 908fe53..ea08cc8 100644 --- a/include/boost/preprocessor/cat.hpp +++ b/include/boost/preprocessor/cat.hpp @@ -19,7 +19,7 @@ //! Delays the catenation of L and R. /*! -Example: +For example,
\verbatim
   #define STATIC_ASSERT(EXPR)\
@@ -36,7 +36,7 @@ Example:
   STATIC_ASSERT(sizeof(int) <= sizeof(long));
 \endverbatim
-The above expands to: +expands to:
\verbatim
   enum
diff --git a/include/boost/preprocessor/identity.hpp b/include/boost/preprocessor/identity.hpp
index 860ddd8..f569e7f 100644
--- a/include/boost/preprocessor/identity.hpp
+++ b/include/boost/preprocessor/identity.hpp
@@ -23,14 +23,14 @@
 /*!
 Designed to be used with BOOST_PP_IF(), when one of the clauses need to be invoked.
 
-Example:
+For example,
 
 
\verbatim
   BOOST_PP_IDENTITY(X)()
   //                  ^^ NOTE!
 \endverbatim
-The above expands to: +expands to:
\verbatim
   X
diff --git a/include/boost/preprocessor/stringize.hpp b/include/boost/preprocessor/stringize.hpp
index a93d98b..2cd0ca0 100644
--- a/include/boost/preprocessor/stringize.hpp
+++ b/include/boost/preprocessor/stringize.hpp
@@ -19,7 +19,7 @@
 
 //! Delays the stringization of E.
 /*!
-Example:
+For example,
 
 
\verbatim
 #define NOTE(STR)\
@@ -30,7 +30,7 @@ Example:
 #pragma NOTE("TBD!")
 \endverbatim
-The above expands to: +expands to:
\verbatim
   #pragma message("examples.cpp" "(" "20" ") : " "TBD!")
diff --git a/include/boost/preprocessor/tuple/eat.hpp b/include/boost/preprocessor/tuple/eat.hpp
index 2438fa7..08220c0 100644
--- a/include/boost/preprocessor/tuple/eat.hpp
+++ b/include/boost/preprocessor/tuple/eat.hpp
@@ -22,13 +22,13 @@
 BOOST_PP_TUPLE_EAT() is designed to be used with BOOST_PP_IF() like
 BOOST_PP_EMPTY().
 
-For example:
+For example,
 
 
\verbatim
   BOOST_PP_IF(0,BOOST_PP_ENUM_PARAMS,BOOST_PP_TUPLE_EAT(2))(10,P)
 \endverbatim
-The above expands to nothing. +expands to nothing. */ #define BOOST_PP_TUPLE_EAT(N) BOOST_PP_TUPLE_EAT_DELAY(N) diff --git a/include/boost/preprocessor/tuple/elem.hpp b/include/boost/preprocessor/tuple/elem.hpp index 862b28c..f869bf3 100644 --- a/include/boost/preprocessor/tuple/elem.hpp +++ b/include/boost/preprocessor/tuple/elem.hpp @@ -21,6 +21,14 @@ //! Expands to the I:th element of an N-tuple. /*! +For example, + +
\verbatim
+  BOOST_PP_TUPLE_ELEM(2,1,(A,B))
+\endverbatim
+ +expands to B. + Tuples can be used for representing structured data. Examples of tuples: @@ -31,14 +39,6 @@ Examples of tuples: 4-tuple: (A B C, D, EF, 34) \endverbatim
-Example: - -
\verbatim
-  BOOST_PP_TUPLE_ELEM(2,1,(A,B))
-\endverbatim
- -The above expands to B. - See also BOOST_PP_LIMIT_TUPLE. */ #define BOOST_PP_TUPLE_ELEM(N,I,T) BOOST_PP_TUPLE_ELEM_DELAY(N,I,T)