forked from boostorg/preprocessor
lib cleanup
[SVN r15693]
This commit is contained in:
48
doc/ref/iteration_limits.html
Normal file
48
doc/ref/iteration_limits.html
Normal file
@ -0,0 +1,48 @@
|
||||
<html>
|
||||
<head>
|
||||
<title>BOOST_PP_ITERATION_LIMITS</title>
|
||||
<link rel="stylesheet" type="text/css" href="../styles.css">
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div style="margin-left: 0px;">
|
||||
The <b>BOOST_PP_ITERATION_LIMITS</b> macro is a user-defined <i>named external argument</i> used by <b>BOOST_PP_ITERATE</b>.
|
||||
It denotes the lower and upper bounds of a <i>file-iteration</i>.
|
||||
</div>
|
||||
<h4>Usage</h4>
|
||||
<div class="code">
|
||||
#define <b>BOOST_PP_ITERATION_LIMITS</b> (<i>start</i>, <i>finish</i>)
|
||||
</div>
|
||||
<h4>Arguments</h4>
|
||||
<dl>
|
||||
<dt>start</dt>
|
||||
<dd>
|
||||
The lower bound (inclusive) of a <i>file-iteration</i>.
|
||||
Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_ITERATION</b>.
|
||||
</dd>
|
||||
<dt>finish</dt>
|
||||
<dd>
|
||||
The upper bound (inclusive) of a <i>file-iteration</i>.
|
||||
Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_ITERATION</b>.
|
||||
</dd>
|
||||
</dl>
|
||||
<h4>Remarks</h4>
|
||||
<div>
|
||||
Note that there is a whitespace character after the macro identifier.
|
||||
</div>
|
||||
<div>
|
||||
This macro is part of the secondary method of passing arguments to <b>BOOST_PP_ITERATE</b>.
|
||||
The other part is <b>BOOST_PP_FILENAME_<i>x</i></b>. Both <i>start</i> and <i>finish</i> are <i>evaluated parameters</i>.
|
||||
This implies that they may include simple arithmetic.
|
||||
</div>
|
||||
<div>
|
||||
This macro is automatically undefined for reuse by a call to <b>BOOST_PP_ITERATE</b>.
|
||||
</div>
|
||||
<h4>See Also</h4>
|
||||
<ul>
|
||||
<li><a href="filename_x.html">BOOST_PP_FILENAME_<i>x</i></a></li>
|
||||
<li><a href="iterate.html">BOOST_PP_ITERATE</a></li>
|
||||
<li><a href="limit_iteration.html">BOOST_PP_LIMIT_ITERATION</a></li>
|
||||
</ul>
|
||||
</body>
|
||||
</html>
|
Reference in New Issue
Block a user