forked from boostorg/preprocessor
initial revision
[SVN r15198]
This commit is contained in:
73
docs.1/ref/enum_params_with_a_default.html
Normal file
73
docs.1/ref/enum_params_with_a_default.html
Normal file
@ -0,0 +1,73 @@
|
||||
<html>
|
||||
<head>
|
||||
<title>BOOST_PP_ENUM_PARAMS_WITH_A_DEFAULT</title>
|
||||
<link rel="stylesheet" type="text/css" href="../styles.css">
|
||||
<script language="javascript" type="text/javascript" src="../scripts.js"></script>
|
||||
</head>
|
||||
<body onload="init('sample');">
|
||||
<div style="margin-left: 0px;">
|
||||
The <b>BOOST_PP_ENUM_PARAMS_WITH_A_DEFAULT</b> macro generates a comma-separated list of parameters with a default argument.
|
||||
</div>
|
||||
<h4>Usage</h4>
|
||||
<div class="code">
|
||||
<b>BOOST_PP_ENUM_PARAMS_WITH_A_DEFAULT</b>(<i>count</i>, <i>param</i>, <i>def</i>)
|
||||
</div>
|
||||
<h4>Arguments</h4>
|
||||
<dl>
|
||||
<dt>count</dt>
|
||||
<dd>
|
||||
The number of parameters to generate.
|
||||
Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_REPEAT</b>.
|
||||
</dd>
|
||||
<dt>param</dt>
|
||||
<dd>
|
||||
The text of the parameter.
|
||||
<b>BOOST_PP_ENUM_PARAMS_WITH_A_DEFAULT</b> concatenates numbers ranging from <i>0</i> to <i>count</i> - <i>1</i>
|
||||
to generate parameters.
|
||||
</dd>
|
||||
<dt>def</dt>
|
||||
<dd>
|
||||
The default value that trails each parameter.
|
||||
</dd>
|
||||
</dl>
|
||||
<h4>Remarks</h4>
|
||||
<div>
|
||||
This macro expands to the comma-separated sequence:
|
||||
<div>
|
||||
<i>param</i> ## <i>0</i> = <i>def</i>, <i>param</i> ## <i>1</i> = <i>def</i>, ... <i>param</i> ## <i>count</i> - <i>1</i> = <i>def</i>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
Previously, this macro could not be used recursively inside <b>BOOST_PP_REPEAT</b>.
|
||||
This limitation no longer exists, as the library can automatically detect the next available repetition depth.
|
||||
</div>
|
||||
<div>
|
||||
This macro is deprecated.
|
||||
It only exists for backward compatibility.
|
||||
Use <b>BOOST_PP_ENUM_BINARY_PARAMS</b> with <b>BOOST_PP_INTERCEPT</b> instead:
|
||||
<div>
|
||||
<b>BOOST_PP_ENUM_BINARY_PARAMS</b>(<i>count</i>, <i>param</i>, = <i>def</i> <b>BOOST_PP_INTERCEPT</b>)
|
||||
</div>
|
||||
</div>
|
||||
<h4>See Also</h4>
|
||||
<ul>
|
||||
<li><a href="enum_binary_params.html">BOOST_PP_ENUM_BINARY_PARAMS</a></li>
|
||||
<li><a href="intercept.html">BOOST_PP_INTERCEPT</a></li>
|
||||
<li><a href="limit_repeat.html">BOOST_PP_LIMIT_REPEAT</a></li>
|
||||
</ul>
|
||||
<h4>Requirements</h4>
|
||||
<div>
|
||||
<b>Header:</b> <a href="../headers/repetition/enum_params_with_a_default.hpp.html"><boost/preprocessor/repetition/enum_params_with_a_default.hpp></a>
|
||||
</div>
|
||||
<h4><a class="local" onclick="toggle('sample');" onmouseover="change(this);" onmouseout="revert(this);">Sample Code</a></h4>
|
||||
<div id="sample"><pre>
|
||||
#include <boost/preprocessor/repetition/enum_params_with_a_default.hpp>
|
||||
|
||||
BOOST_PP_ENUM_PARAMS_WITH_A_DEFAULT(3, class T, int)
|
||||
// expands to T0 = int, T1 = int, T2 = int
|
||||
|
||||
BOOST_PP_ENUM_BINARY_PARAMS(3, class T, = int BOOST_PP_INTERCEPT)
|
||||
// expands to T0 = int, T1 = int, T2 = int
|
||||
<pre></div>
|
||||
</body>
|
||||
</html>
|
Reference in New Issue
Block a user