Squashed 'third_party/boostorg/preprocessor/' content from commit 56090c5
Change-Id: I8c0a13225778c3751a35945439d5304bd9e639ef
git-subtree-dir: third_party/boostorg/preprocessor
git-subtree-split: 56090c56b5c78418b6dbe8c3c2ba576395152f83
diff --git a/doc/ref/enum.html b/doc/ref/enum.html
new file mode 100644
index 0000000..e9fe446
--- /dev/null
+++ b/doc/ref/enum.html
@@ -0,0 +1,80 @@
+<html>
+<head>
+ <title>BOOST_PP_ENUM</title>
+ <link rel="stylesheet" type="text/css" href="../styles.css">
+</head>
+<body>
+ <div style="margin-left: 0px;">
+ The <b>BOOST_PP_ENUM</b> macro generates a comma-separated list.
+ </div>
+ <h4>Usage</h4>
+ <div class="code">
+ <b>BOOST_PP_ENUM</b>(<i>count</i>, <i>macro</i>, <i>data</i>)
+ </div>
+ <h4>Arguments</h4>
+ <dl>
+ <dt>count</dt>
+ <dd>
+ The number of repetitious calls to <i>macro</i>.
+ Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_REPEAT</b>.
+ </dd>
+ <dt>macro</dt>
+ <dd>
+ A ternary operation of the form <i>macro</i>(<i>z</i>, <i>n</i>, <i>data</i>).
+ This macro is expanded by <b>BOOST_PP_ENUM</b> with the next available repetition depth,
+ the current repetition number, and the auxiliary <i>data</i> argument.
+ </dd>
+ <dt>data</dt>
+ <dd>
+ Auxiliary data passed to <i>macro</i>.
+ </dd>
+ </dl>
+ <h4>Remarks</h4>
+ <div>
+ This macro expands to the comma-separated sequence:
+ <div>
+ <i>macro</i>(<i>z</i>, <i>0</i>, <i>data</i>), <i>macro</i>(<i>z</i>, <i>1</i>, <i>data</i>), ... <i>macro</i>(<i>z</i>, <i>count</i> - <i>1</i>, <i>data</i>)
+ </div>
+ </div>
+ <div>
+ The <i>z</i> value that is passed to <i>macro</i> represents the next available repetition dimension.
+ Other macros that have <b>_Z</b> suffix variants internally use <b>BOOST_PP_REPEAT</b>--for example, <b>BOOST_PP_ENUM_PARAMS</b> and <b>BOOST_PP_ENUM_PARAMS_Z</b>.
+ Using these <b>_Z</b> versions is not strictly necessary, but passing the <i>z</i> value (that is passed to <i>macro</i>) to these macros allows them to reenter <b>BOOST_PP_REPEAT</b> with maximum efficiency.
+ </div>
+ <div>
+ To directly use this <i>z</i> value, rather than simply passing it to another macro, see <b>BOOST_PP_ENUM_<i>z</i></b>.
+ </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>
+ <h4>See Also</h4>
+ <ul>
+ <li><a href="enum_z.html">BOOST_PP_ENUM_<i>z</i></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.html"><boost/preprocessor/repetition/enum.hpp></a>
+ </div>
+ <h4>Sample Code</h4>
+<div><pre>
+#include <<a href="../headers/repetition/enum.html">boost/preprocessor/repetition/enum.hpp</a>>
+
+#define TEXT(z, n, text) text
+
+<a href="enum.html">BOOST_PP_ENUM</a>(4, TEXT, class) // expands to class, class, class, class
+</pre></div>
+ <hr size="1">
+ <div style="margin-left: 0px;">
+ <i>© Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i>
+ </br><i>© Copyright Paul Mensonides 2002</i>
+ </div>
+ <div style="margin-left: 0px;">
+ <p><small>Distributed under the Boost Software License, Version 1.0. (See
+ accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
+ copy at <a href=
+ "http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
+ </div>
+</body>
+</html>