forked from boostorg/preprocessor
lib cleanup
[SVN r15693]
This commit is contained in:
62
doc/ref/frame_iteration.html
Normal file
62
doc/ref/frame_iteration.html
Normal file
@ -0,0 +1,62 @@
|
||||
<html>
|
||||
<head>
|
||||
<title>BOOST_PP_FRAME_ITERATION</title>
|
||||
<link rel="stylesheet" type="text/css" href="../styles.css">
|
||||
</head>
|
||||
<body>
|
||||
<div style="margin-left: 0px;">
|
||||
The <b>BOOST_PP_FRAME_ITERATION</b> macro expands to the iteration value of an absolute <i>file-iteration</i> depth.
|
||||
</div>
|
||||
<h4>Usage</h4>
|
||||
<div class="code">
|
||||
<b>BOOST_PP_FRAME_ITERATION</b>(<i>i</i>)
|
||||
</div>
|
||||
<h4>Arguments</h4>
|
||||
<dl>
|
||||
<dt>i</dt>
|
||||
<dd>
|
||||
The absolute depth of the frame whose iteration value is to be retreived.
|
||||
Valid values range from <i>1</i> to <b>BOOST_PP_ITERATION_DEPTH</b>().
|
||||
</dd>
|
||||
</dl>
|
||||
<h4>Remarks</h4>
|
||||
<div>
|
||||
This macro is only valid when a <i>file-iteration</i> is in progress.
|
||||
</div>
|
||||
<h4>Requirements</h4>
|
||||
<div>
|
||||
<b>Header:</b> <a href="../headers/iteration/iterate.hpp.html"><boost/preprocessor/iteration/iterate.hpp></a>
|
||||
</div>
|
||||
<h4>Sample Code</h4>
|
||||
<div><pre>
|
||||
// file.h
|
||||
#if !<a href="is_iterating.html">BOOST_PP_IS_ITERATING</a>
|
||||
|
||||
#ifndef FILE_H_
|
||||
#define FILE_H_
|
||||
|
||||
#include <<a href="../headers/iteration/iterate.hpp.html">boost/preprocessor/iteration/iterate.hpp</a>>
|
||||
|
||||
#define <a href="iteration_params_x.html">BOOST_PP_ITERATION_PARAMS_1</a> (3, (1, 10, "file.h"))
|
||||
#include <a href="iterate.html">BOOST_PP_ITERATE</a>()
|
||||
|
||||
#endif
|
||||
|
||||
#elif <a href="iteration_depth.html">BOOST_PP_ITERATION_DEPTH</a>() == 1
|
||||
|
||||
--
|
||||
#define <a href="iteration_params_x.html">BOOST_PP_ITERATION_PARAMS_2</a> \
|
||||
(3, (1, <a href="iteration.html">BOOST_PP_ITERATION</a>(), "file.h")) \
|
||||
/**/
|
||||
|
||||
#include <a href="iterate.html">BOOST_PP_ITERATE</a>()
|
||||
|
||||
#else
|
||||
|
||||
outer: <a href="frame_iteration.html">BOOST_PP_FRAME_ITERATION</a>(1)
|
||||
inner: <a href="frame_iteration.html">BOOST_PP_FRAME_ITERATION</a>(2)
|
||||
|
||||
#endif
|
||||
</pre></div>
|
||||
</body>
|
||||
</html>
|
Reference in New Issue
Block a user