From 336749e0ae7196f2da3c22cbb26b6d81a7a446d6 Mon Sep 17 00:00:00 2001 From: Vesa Karvonen Date: Fri, 12 Apr 2002 12:16:05 +0000 Subject: [PATCH] Added requirements on numeric parameters [SVN r13460] --- doc/reference/arithmetic_add.htm | 3 +++ doc/reference/arithmetic_div.htm | 3 +++ doc/reference/arithmetic_mod.htm | 3 +++ doc/reference/arithmetic_mul.htm | 3 +++ doc/reference/arithmetic_sub.htm | 3 +++ doc/reference/assert_msg.htm | 2 +- doc/reference/comma_if.htm | 2 +- doc/reference/comparison_equal.htm | 3 ++- doc/reference/comparison_greater.htm | 3 ++- doc/reference/comparison_greater_equal.htm | 3 ++- doc/reference/comparison_less.htm | 3 ++- doc/reference/comparison_less_equal.htm | 3 ++- doc/reference/comparison_not_equal.htm | 3 ++- doc/reference/expr_if.htm | 2 +- doc/reference/if.htm | 2 +- doc/reference/logical_and.htm | 3 +++ doc/reference/logical_bool.htm | 2 ++ doc/reference/logical_nor.htm | 3 +++ doc/reference/logical_not.htm | 2 ++ doc/reference/logical_or.htm | 3 +++ doc/reference/logical_xor.htm | 3 +++ doc/reference/max.htm | 3 +++ doc/reference/min.htm | 3 +++ include/boost/preprocessor/arithmetic/add.hpp | 3 +++ include/boost/preprocessor/arithmetic/div.hpp | 3 +++ include/boost/preprocessor/arithmetic/mod.hpp | 3 +++ include/boost/preprocessor/arithmetic/mul.hpp | 3 +++ include/boost/preprocessor/arithmetic/sub.hpp | 3 +++ include/boost/preprocessor/assert_msg.hpp | 2 +- include/boost/preprocessor/comma_if.hpp | 2 +- include/boost/preprocessor/comparison/equal.hpp | 3 ++- include/boost/preprocessor/comparison/greater.hpp | 3 ++- include/boost/preprocessor/comparison/greater_equal.hpp | 3 ++- include/boost/preprocessor/comparison/less.hpp | 3 ++- include/boost/preprocessor/comparison/less_equal.hpp | 3 ++- include/boost/preprocessor/comparison/not_equal.hpp | 3 ++- include/boost/preprocessor/expr_if.hpp | 2 +- include/boost/preprocessor/if.hpp | 2 +- include/boost/preprocessor/logical/and.hpp | 3 +++ include/boost/preprocessor/logical/bool.hpp | 2 ++ include/boost/preprocessor/logical/nor.hpp | 3 +++ include/boost/preprocessor/logical/not.hpp | 2 ++ include/boost/preprocessor/logical/or.hpp | 3 +++ include/boost/preprocessor/logical/xor.hpp | 3 +++ include/boost/preprocessor/max.hpp | 3 +++ include/boost/preprocessor/min.hpp | 3 +++ 46 files changed, 106 insertions(+), 20 deletions(-) diff --git a/doc/reference/arithmetic_add.htm b/doc/reference/arithmetic_add.htm index 25b98e0..89aeeac 100644 --- a/doc/reference/arithmetic_add.htm +++ b/doc/reference/arithmetic_add.htm @@ -29,6 +29,9 @@

#define BOOST_PP_ADD(X,Y)

Expands to the sum of X and Y.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_ADD(4,3) expands to 7 (a single token).

diff --git a/doc/reference/arithmetic_div.htm b/doc/reference/arithmetic_div.htm index bc7e1ba..ca04763 100644 --- a/doc/reference/arithmetic_div.htm +++ b/doc/reference/arithmetic_div.htm @@ -29,6 +29,9 @@

#define BOOST_PP_DIV(X,Y)

Expands to the quotient of X and Y.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_DIV(4,3) expands to 1 (a single token).

diff --git a/doc/reference/arithmetic_mod.htm b/doc/reference/arithmetic_mod.htm index 5b3c7a3..1f083e4 100644 --- a/doc/reference/arithmetic_mod.htm +++ b/doc/reference/arithmetic_mod.htm @@ -29,6 +29,9 @@

#define BOOST_PP_MOD(X,Y)

Expands to the remainder of X and Y.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_MOD(4,3) expands to 1 (a single token).

diff --git a/doc/reference/arithmetic_mul.htm b/doc/reference/arithmetic_mul.htm index 773ea3e..1a3739a 100644 --- a/doc/reference/arithmetic_mul.htm +++ b/doc/reference/arithmetic_mul.htm @@ -29,6 +29,9 @@

#define BOOST_PP_MUL(X,Y)

Expands to the product of X and Y.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_MUL(4,3) expands to 12 (a single token).

diff --git a/doc/reference/arithmetic_sub.htm b/doc/reference/arithmetic_sub.htm index 896d843..5b49389 100644 --- a/doc/reference/arithmetic_sub.htm +++ b/doc/reference/arithmetic_sub.htm @@ -29,6 +29,9 @@

#define BOOST_PP_SUB(X,Y)

Expands to the difference of X and Y.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_SUB(4,3) expands to 1 (a single token).

diff --git a/doc/reference/assert_msg.htm b/doc/reference/assert_msg.htm index 872a46e..38c36a8 100644 --- a/doc/reference/assert_msg.htm +++ b/doc/reference/assert_msg.htm @@ -30,7 +30,7 @@

Expands to nothing if COND != 0 and to MSG if COND == 0.

-

COND must expand to an integer literal.

+

COND must expand to an integer literal in the range [0, BOOST_PP_LIMIT_MAG].

For example, BOOST_PP_ASSERT_MSG(1,A BUG!) expands to A BUG!.

diff --git a/doc/reference/comma_if.htm b/doc/reference/comma_if.htm index d97b47a..7da2918 100644 --- a/doc/reference/comma_if.htm +++ b/doc/reference/comma_if.htm @@ -30,7 +30,7 @@

Expands to a comma if COND != 0 and nothing if COND == 0.

-

COND must expand to an integer literal.

+

COND must expand to an integer literal in the range [0, BOOST_PP_LIMIT_MAG].

For example, BOOST_PP_COMMA_IF(0) expands to nothing.

diff --git a/doc/reference/comparison_equal.htm b/doc/reference/comparison_equal.htm index f2b0b89..2f1dabe 100644 --- a/doc/reference/comparison_equal.htm +++ b/doc/reference/comparison_equal.htm @@ -30,7 +30,8 @@

Expands to 1 if X == Y and 0 otherwise.

-

Both X and Y must expand to integer literals.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

For example, BOOST_PP_EQUAL(4,4) expands to 1.

diff --git a/doc/reference/comparison_greater.htm b/doc/reference/comparison_greater.htm index ddbf679..6350b1e 100644 --- a/doc/reference/comparison_greater.htm +++ b/doc/reference/comparison_greater.htm @@ -30,7 +30,8 @@

Expands to 1 if X > Y and 0 otherwise.

-

Both X and Y must expand to integer literals.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

For example, BOOST_PP_GREATER(4,3) expands to 1.

diff --git a/doc/reference/comparison_greater_equal.htm b/doc/reference/comparison_greater_equal.htm index 96f8f74..af5c0b3 100644 --- a/doc/reference/comparison_greater_equal.htm +++ b/doc/reference/comparison_greater_equal.htm @@ -30,7 +30,8 @@

Expands to 1 if X >= Y and 0 otherwise.

-

Both X and Y must expand to integer literals.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

For example, BOOST_PP_GREATER_EQUAL(1,3) expands to 0.

diff --git a/doc/reference/comparison_less.htm b/doc/reference/comparison_less.htm index be8874e..fde8aba 100644 --- a/doc/reference/comparison_less.htm +++ b/doc/reference/comparison_less.htm @@ -30,7 +30,8 @@

Expands to 1 if X < Y and 0 otherwise.

-

Both X and Y must expand to integer literals.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

For example, BOOST_PP_LESS(2,6) expands to 1.

diff --git a/doc/reference/comparison_less_equal.htm b/doc/reference/comparison_less_equal.htm index 7da486e..5134575 100644 --- a/doc/reference/comparison_less_equal.htm +++ b/doc/reference/comparison_less_equal.htm @@ -30,7 +30,8 @@

Expands to 1 if X <= Y and 0 otherwise.

-

X must expand to an integer literal.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

For example, BOOST_PP_LESS_EQUAL(7,5) expands to 0.

diff --git a/doc/reference/comparison_not_equal.htm b/doc/reference/comparison_not_equal.htm index f579d5b..a177841 100644 --- a/doc/reference/comparison_not_equal.htm +++ b/doc/reference/comparison_not_equal.htm @@ -30,7 +30,8 @@

Expands to 1 if X != Y and 0 otherwise.

-

Both X and Y must expand to integer literals.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

For example, BOOST_PP_NOT_EQUAL(4,4) expands to 0.

diff --git a/doc/reference/expr_if.htm b/doc/reference/expr_if.htm index 2b0ca38..f965150 100644 --- a/doc/reference/expr_if.htm +++ b/doc/reference/expr_if.htm @@ -29,7 +29,7 @@

#define BOOST_PP_EXPR_IF(COND,EXPR)

Expands to EXPR if COND != 0 and to nothing if COND == 0.

-

COND must expand to an integer literal.

+

COND must expand to an integer literal in the range [0, BOOST_PP_LIMIT_MAG].

For example, BOOST_PP_EXPR_IF(1,^) expands to ^.

diff --git a/doc/reference/if.htm b/doc/reference/if.htm index 0f405a2..563ce4e 100644 --- a/doc/reference/if.htm +++ b/doc/reference/if.htm @@ -30,7 +30,7 @@

Expands to THEN if COND != 0 and ELSE if COND == 0.

-

COND must expand to an integer literal.

+

COND must expand to an integer literal in the range [0, BOOST_PP_LIMIT_MAG].

For example, BOOST_PP_IF(0,1,2) expands to 2.

diff --git a/doc/reference/logical_and.htm b/doc/reference/logical_and.htm index 151cfbf..9f3fa67 100644 --- a/doc/reference/logical_and.htm +++ b/doc/reference/logical_and.htm @@ -29,6 +29,9 @@

#define BOOST_PP_AND(X,Y)

Expands to the logical AND of the operands.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_AND(0,5) expands to 0 (a single token).

Test

diff --git a/doc/reference/logical_bool.htm b/doc/reference/logical_bool.htm index 80fcbf6..47f7046 100644 --- a/doc/reference/logical_bool.htm +++ b/doc/reference/logical_bool.htm @@ -29,6 +29,8 @@

#define BOOST_PP_BOOL(X)

Expands to 0 if X == 0 and 1 if X != 0.

+

X must be an integer literal in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_BOOL(3) expands to 1.

diff --git a/doc/reference/logical_nor.htm b/doc/reference/logical_nor.htm index 8512f33..29203db 100644 --- a/doc/reference/logical_nor.htm +++ b/doc/reference/logical_nor.htm @@ -29,6 +29,9 @@

#define BOOST_PP_NOR(X,Y)

Expands to the logical NEITHER OR of the operands.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_NOR(0,5) expands to 0 (a single token).

Test

diff --git a/doc/reference/logical_not.htm b/doc/reference/logical_not.htm index 35002fc..456930e 100644 --- a/doc/reference/logical_not.htm +++ b/doc/reference/logical_not.htm @@ -29,6 +29,8 @@

#define BOOST_PP_NOT(X)

Expands to the logical NOT of the operand.

+

X must be an integer literal in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_NOT(0) expands to 1 (a single token).

Test

diff --git a/doc/reference/logical_or.htm b/doc/reference/logical_or.htm index 61236a9..5852a8b 100644 --- a/doc/reference/logical_or.htm +++ b/doc/reference/logical_or.htm @@ -29,6 +29,9 @@

#define BOOST_PP_OR(X,Y)

Expands to the logical OR of the operands.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_OR(0,2) expands to 1 (a single token).

Test

diff --git a/doc/reference/logical_xor.htm b/doc/reference/logical_xor.htm index 48e5a5a..4afd92b 100644 --- a/doc/reference/logical_xor.htm +++ b/doc/reference/logical_xor.htm @@ -29,6 +29,9 @@

#define BOOST_PP_XOR(X,Y)

Expands to the logical EXCLUSIVE OR of the operands.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_XOR(1,2) expands to 0 (a single token).

Test

diff --git a/doc/reference/max.htm b/doc/reference/max.htm index 2915db8..ca6dc57 100644 --- a/doc/reference/max.htm +++ b/doc/reference/max.htm @@ -29,6 +29,9 @@

#define BOOST_PP_MAX(X,Y)

Expands to the maximum of X and Y.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_MAX(5,7) expands to 7 (a single token).

diff --git a/doc/reference/min.htm b/doc/reference/min.htm index 8d42839..fde2ca2 100644 --- a/doc/reference/min.htm +++ b/doc/reference/min.htm @@ -29,6 +29,9 @@

#define BOOST_PP_MIN(X,Y)

Expands to the minimum of X and Y.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_MIN(5,7) expands to 5 (a single token).

diff --git a/include/boost/preprocessor/arithmetic/add.hpp b/include/boost/preprocessor/arithmetic/add.hpp index 2bc902f..cda5ef9 100644 --- a/include/boost/preprocessor/arithmetic/add.hpp +++ b/include/boost/preprocessor/arithmetic/add.hpp @@ -20,6 +20,9 @@ /**

Expands to the sum of X and Y.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_ADD(4,3) expands to 7 (a single token).

diff --git a/include/boost/preprocessor/arithmetic/div.hpp b/include/boost/preprocessor/arithmetic/div.hpp index ad191ad..830dbc3 100644 --- a/include/boost/preprocessor/arithmetic/div.hpp +++ b/include/boost/preprocessor/arithmetic/div.hpp @@ -18,6 +18,9 @@ /**

Expands to the quotient of X and Y.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_DIV(4,3) expands to 1 (a single token).

diff --git a/include/boost/preprocessor/arithmetic/mod.hpp b/include/boost/preprocessor/arithmetic/mod.hpp index 4e1aa9b..7755cc6 100644 --- a/include/boost/preprocessor/arithmetic/mod.hpp +++ b/include/boost/preprocessor/arithmetic/mod.hpp @@ -17,6 +17,9 @@ /**

Expands to the remainder of X and Y.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_MOD(4,3) expands to 1 (a single token).

diff --git a/include/boost/preprocessor/arithmetic/mul.hpp b/include/boost/preprocessor/arithmetic/mul.hpp index 339a4b8..7c0fb77 100644 --- a/include/boost/preprocessor/arithmetic/mul.hpp +++ b/include/boost/preprocessor/arithmetic/mul.hpp @@ -17,6 +17,9 @@ /**

Expands to the product of X and Y.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_MUL(4,3) expands to 12 (a single token).

diff --git a/include/boost/preprocessor/arithmetic/sub.hpp b/include/boost/preprocessor/arithmetic/sub.hpp index a7f4f14..7f41bfc 100644 --- a/include/boost/preprocessor/arithmetic/sub.hpp +++ b/include/boost/preprocessor/arithmetic/sub.hpp @@ -19,6 +19,9 @@ /**

Expands to the difference of X and Y.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_SUB(4,3) expands to 1 (a single token).

diff --git a/include/boost/preprocessor/assert_msg.hpp b/include/boost/preprocessor/assert_msg.hpp index 731e6e2..8de71c2 100644 --- a/include/boost/preprocessor/assert_msg.hpp +++ b/include/boost/preprocessor/assert_msg.hpp @@ -19,7 +19,7 @@ /**

Expands to nothing if COND != 0 and to MSG if COND == 0.

-

COND must expand to an integer literal.

+

COND must expand to an integer literal in the range [0, BOOST_PP_LIMIT_MAG].

For example, BOOST_PP_ASSERT_MSG(1,A BUG!) expands to A BUG!.

*/ diff --git a/include/boost/preprocessor/comma_if.hpp b/include/boost/preprocessor/comma_if.hpp index 6ac9861..c7f2581 100644 --- a/include/boost/preprocessor/comma_if.hpp +++ b/include/boost/preprocessor/comma_if.hpp @@ -20,7 +20,7 @@ /**

Expands to a comma if COND != 0 and nothing if COND == 0.

-

COND must expand to an integer literal.

+

COND must expand to an integer literal in the range [0, BOOST_PP_LIMIT_MAG].

For example, BOOST_PP_COMMA_IF(0) expands to nothing.

*/ diff --git a/include/boost/preprocessor/comparison/equal.hpp b/include/boost/preprocessor/comparison/equal.hpp index e7f3cef..ce5063e 100644 --- a/include/boost/preprocessor/comparison/equal.hpp +++ b/include/boost/preprocessor/comparison/equal.hpp @@ -19,7 +19,8 @@ /**

Expands to 1 if X == Y and 0 otherwise.

-

Both X and Y must expand to integer literals.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

For example, BOOST_PP_EQUAL(4,4) expands to 1.

diff --git a/include/boost/preprocessor/comparison/greater.hpp b/include/boost/preprocessor/comparison/greater.hpp index bdf417b..6199d6e 100644 --- a/include/boost/preprocessor/comparison/greater.hpp +++ b/include/boost/preprocessor/comparison/greater.hpp @@ -18,7 +18,8 @@ /**

Expands to 1 if X > Y and 0 otherwise.

-

Both X and Y must expand to integer literals.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

For example, BOOST_PP_GREATER(4,3) expands to 1.

diff --git a/include/boost/preprocessor/comparison/greater_equal.hpp b/include/boost/preprocessor/comparison/greater_equal.hpp index 862b498..a951d09 100644 --- a/include/boost/preprocessor/comparison/greater_equal.hpp +++ b/include/boost/preprocessor/comparison/greater_equal.hpp @@ -18,7 +18,8 @@ /**

Expands to 1 if X >= Y and 0 otherwise.

-

Both X and Y must expand to integer literals.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

For example, BOOST_PP_GREATER_EQUAL(1,3) expands to 0.

diff --git a/include/boost/preprocessor/comparison/less.hpp b/include/boost/preprocessor/comparison/less.hpp index 711fa48..4f916cd 100644 --- a/include/boost/preprocessor/comparison/less.hpp +++ b/include/boost/preprocessor/comparison/less.hpp @@ -20,7 +20,8 @@ /**

Expands to 1 if X < Y and 0 otherwise.

-

Both X and Y must expand to integer literals.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

For example, BOOST_PP_LESS(2,6) expands to 1.

diff --git a/include/boost/preprocessor/comparison/less_equal.hpp b/include/boost/preprocessor/comparison/less_equal.hpp index 2aa3fa1..db37b31 100644 --- a/include/boost/preprocessor/comparison/less_equal.hpp +++ b/include/boost/preprocessor/comparison/less_equal.hpp @@ -19,7 +19,8 @@ /**

Expands to 1 if X <= Y and 0 otherwise.

-

X must expand to an integer literal.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

For example, BOOST_PP_LESS_EQUAL(7,5) expands to 0.

diff --git a/include/boost/preprocessor/comparison/not_equal.hpp b/include/boost/preprocessor/comparison/not_equal.hpp index 5f73698..490c136 100644 --- a/include/boost/preprocessor/comparison/not_equal.hpp +++ b/include/boost/preprocessor/comparison/not_equal.hpp @@ -20,7 +20,8 @@ /**

Expands to 1 if X != Y and 0 otherwise.

-

Both X and Y must expand to integer literals.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

For example, BOOST_PP_NOT_EQUAL(4,4) expands to 0.

diff --git a/include/boost/preprocessor/expr_if.hpp b/include/boost/preprocessor/expr_if.hpp index 2f34440..e99f78e 100644 --- a/include/boost/preprocessor/expr_if.hpp +++ b/include/boost/preprocessor/expr_if.hpp @@ -17,7 +17,7 @@ /**

Expands to EXPR if COND != 0 and to nothing if COND == 0.

-

COND must expand to an integer literal.

+

COND must expand to an integer literal in the range [0, BOOST_PP_LIMIT_MAG].

For example, BOOST_PP_EXPR_IF(1,^) expands to ^.

diff --git a/include/boost/preprocessor/if.hpp b/include/boost/preprocessor/if.hpp index ba6229f..e76d047 100644 --- a/include/boost/preprocessor/if.hpp +++ b/include/boost/preprocessor/if.hpp @@ -19,7 +19,7 @@ /**

Expands to THEN if COND != 0 and ELSE if COND == 0.

-

COND must expand to an integer literal.

+

COND must expand to an integer literal in the range [0, BOOST_PP_LIMIT_MAG].

For example, BOOST_PP_IF(0,1,2) expands to 2.

diff --git a/include/boost/preprocessor/logical/and.hpp b/include/boost/preprocessor/logical/and.hpp index 34c5215..d9a4d6b 100644 --- a/include/boost/preprocessor/logical/and.hpp +++ b/include/boost/preprocessor/logical/and.hpp @@ -17,6 +17,9 @@ /**

Expands to the logical AND of the operands.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_AND(0,5) expands to 0 (a single token).

Test

diff --git a/include/boost/preprocessor/logical/bool.hpp b/include/boost/preprocessor/logical/bool.hpp index 2bb144d..856eb89 100644 --- a/include/boost/preprocessor/logical/bool.hpp +++ b/include/boost/preprocessor/logical/bool.hpp @@ -15,6 +15,8 @@ /**

Expands to 0 if X == 0 and 1 if X != 0.

+

X must be an integer literal in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_BOOL(3) expands to 1.

*/ #define BOOST_PP_BOOL(X) BOOST_PP_BOOL_DELAY(X) diff --git a/include/boost/preprocessor/logical/nor.hpp b/include/boost/preprocessor/logical/nor.hpp index 172a551..3ccf8c3 100644 --- a/include/boost/preprocessor/logical/nor.hpp +++ b/include/boost/preprocessor/logical/nor.hpp @@ -17,6 +17,9 @@ /**

Expands to the logical NEITHER OR of the operands.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_NOR(0,5) expands to 0 (a single token).

Test

diff --git a/include/boost/preprocessor/logical/not.hpp b/include/boost/preprocessor/logical/not.hpp index 5d19f92..e008793 100644 --- a/include/boost/preprocessor/logical/not.hpp +++ b/include/boost/preprocessor/logical/not.hpp @@ -17,6 +17,8 @@ /**

Expands to the logical NOT of the operand.

+

X must be an integer literal in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_NOT(0) expands to 1 (a single token).

Test

diff --git a/include/boost/preprocessor/logical/or.hpp b/include/boost/preprocessor/logical/or.hpp index fc98ee5..d95bc6c 100644 --- a/include/boost/preprocessor/logical/or.hpp +++ b/include/boost/preprocessor/logical/or.hpp @@ -17,6 +17,9 @@ /**

Expands to the logical OR of the operands.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_OR(0,2) expands to 1 (a single token).

Test

diff --git a/include/boost/preprocessor/logical/xor.hpp b/include/boost/preprocessor/logical/xor.hpp index 112b79d..49cb88d 100644 --- a/include/boost/preprocessor/logical/xor.hpp +++ b/include/boost/preprocessor/logical/xor.hpp @@ -17,6 +17,9 @@ /**

Expands to the logical EXCLUSIVE OR of the operands.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_XOR(1,2) expands to 0 (a single token).

Test

diff --git a/include/boost/preprocessor/max.hpp b/include/boost/preprocessor/max.hpp index 1ea61ae..4fc1652 100644 --- a/include/boost/preprocessor/max.hpp +++ b/include/boost/preprocessor/max.hpp @@ -18,6 +18,9 @@ /**

Expands to the maximum of X and Y.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_MAX(5,7) expands to 7 (a single token).

diff --git a/include/boost/preprocessor/min.hpp b/include/boost/preprocessor/min.hpp index f7d8a9d..908f9f4 100644 --- a/include/boost/preprocessor/min.hpp +++ b/include/boost/preprocessor/min.hpp @@ -18,6 +18,9 @@ /**

Expands to the minimum of X and Y.

+

Both X and Y must expand to integer literals +in the range [0, BOOST_PP_LIMIT_MAG].

+

For example, BOOST_PP_MIN(5,7) expands to 5 (a single token).