Opened 12 years ago

Closed 12 years ago

#4224 closed Bugs (fixed)

Documentation: Mistakes in Examples

Reported by: tcorbat@… Owned by: No-Maintainer
Milestone: Boost 1.43.0 Component: preprocessor
Version: Boost 1.44.0 Severity: Cosmetic
Keywords: Cc:

Description

Hello

I've implemented a preprocessor for C++ and I used the boost preprocessor library for creating test cases to check if it can handle macro expansion correctly. While implementing these cases I came across tree minor mistakes in the documentation of the boost preprocessor library:

  1. In the documentation of BOOST_PP_LIMIT_ITERATION_DIM (http://www.boost.org/doc/libs/1_42_0/libs/preprocessor/doc/ref/limit_iteration_dim.html): The doc states that this macro expands to 5, but it actually expands to 3
  2. In the documentation of BOOST_PP_IIF (http://www.boost.org/doc/libs/1_42_0/libs/preprocessor/doc/ref/iif.html): In the sample code, a closing angle bracket is missing in the second include directive.
  3. In the documentation of BOOST_PP_ENUM_PARAMS_WITH_A_DEFAULT (http://www.boost.org/doc/libs/1_42_0/libs/preprocessor/doc/ref/enum_params_with_defaults.html): In the sample code, "class" is missing before T0, T1 and T2 in the comment describing the expected result.

The mistakes are the same for the documentation of version 1.42 as well as 1.43.

Regards, Thomas

Change History (1)

comment:1 by Steven Watanabe, 12 years ago

Resolution: fixed
Status: newclosed

(In [62165]) Fix some minor documentation errors. Fixes #4224

Note: See TracTickets for help on using tickets.