feedc0de/boost_preprocessor
1
0
Fork 0
forked from boostorg/preprocessor
Code Pull Requests Activity

Corrected description.

Browse Source 
[SVN r86783]
This commit is contained in:
Edward Diener
2013-11-22 04:00:54 +00:00
parent b8eb1e0149
commit e9bdfe5276
1 changed files with 44 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
doc/ref/array_pop_front.html
View File

@ -1,59 +1,51 @@
<html> <html>
<head> <head>
<meta content="text/html; charset=windows-1252" http-equiv="content-type">
<title>BOOST_PP_ARRAY_POP_FRONT</title> <title>BOOST_PP_ARRAY_POP_FRONT</title>
<link rel="stylesheet" type="text/css" href="../styles.css"> <link rel="stylesheet" type="text/css" href="../styles.css">
</head> </head>
<body> <body>
<div style="margin-left: 0px;"> <div style="margin-left: 0px;"> The <b>BOOST_PP_ARRAY_POP_FRONT</b> macro
The <b>BOOST_PP_ARRAY_POP_FRONT</b> macro pops an element from the end of an <i>array</i>. pops an element from the beginning of an <i>array</i>.</div>
</div>
<h4>Usage</h4> <h4>Usage</h4>
<div class="code"> <div class="code"> <b>BOOST_PP_ARRAY_POP_FRONT</b>(<i>array</i>) </div>
<b>BOOST_PP_ARRAY_POP_FRONT</b>(<i>array</i>)
</div>
<h4>Arguments</h4> <h4>Arguments</h4>
<dl> <dl>
<dt>array</dt> <dt>array</dt>
<dd> <dd> The <i>array</i> to pop an element from. </dd>
The <i>array</i> to pop an element from.
</dd>
</dl> </dl>
<h4>Remarks</h4> <h4>Remarks</h4>
<div> <div> This macro returns <i>array</i> after removing the first
This macro returns <i>array</i> after removing the first element.&nbsp; element.&nbsp; If <i>array</i> has no elements, the result of applying
If <i>array</i> has no elements, the result of applying this macro is undefined. this macro is undefined. </div>
</div> <div> This macro uses <b>BOOST_PP_REPEAT</b> internally.&nbsp; Therefore,
<div> to use the <i>z</i> parameter passed from other macros that use <b>BOOST_PP_REPEAT</b>,
This macro uses <b>BOOST_PP_REPEAT</b> internally.&nbsp; see <b>BOOST_PP_ARRAY_POP_FRONT_Z</b> </div>
Therefore, to use the <i>z</i> parameter passed from other macros that use
<b>BOOST_PP_REPEAT</b>, see <b>BOOST_PP_ARRAY_POP_FRONT_Z</b>
</div>
<h4>See Also</h4> <h4>See Also</h4>
<ul> <ul>
<li><a href="array_pop_front_z.html">BOOST_PP_ARRAY_POP_FRONT_Z</a></li> <li><a href="array_pop_front_z.html">BOOST_PP_ARRAY_POP_FRONT_Z</a></li>
</ul> </ul>
<h4>Requirements</h4> <h4>Requirements</h4>
<div> <div> <b>Header:</b> &nbsp;<a href="../headers/array/pop_front.html">&lt;boost/preprocessor/array/pop_front.hpp&gt;</a>
<b>Header:</b> &nbsp;<a href="../headers/array/pop_front.html">&lt;boost/preprocessor/array/pop_front.hpp&gt;</a>
</div> </div>
<h4>Sample Code</h4> <h4>Sample Code</h4>
<div><pre> <div>
#include &lt;<a href="../headers/array/pop_front.html">boost/preprocessor/array/pop_front.hpp</a>&gt; <pre>#include &lt;<a href="../headers/array/pop_front.html">boost/preprocessor/array/pop_front.hpp</a>&gt;
#define ARRAY (3, (a, b, c)) #define ARRAY (3, (a, b, c))
<a href="array_pop_front.html">BOOST_PP_ARRAY_POP_FRONT</a>(ARRAY) // expands to (2, (b, c)) <a href="array_pop_front.html">BOOST_PP_ARRAY_POP_FRONT</a>(ARRAY) // expands to (2, (b, c))
</pre></div> </pre></div>
<hr size="1"> <hr size="1">
<div style="margin-left: 0px;"> <div style="margin-left: 0px;"> <i><EFBFBD> Copyright <a href="http://www.housemarque.com"
<i><EFBFBD> Copyright <a href="http://www.housemarque.com" target="_top">Housemarque Oy</a> 2002</i> target="_top">Housemarque Oy</a> 2002</i> <br>
</br><i><EFBFBD> Copyright Paul Mensonides 2002</i> <i><EFBFBD> Copyright Paul Mensonides 2002<br>
</i><i><EFBFBD> Copyright Edward Diener 2013</i><br>
</div> </div>
<div style="margin-left: 0px;"> <div style="margin-left: 0px;">
<p><small>Distributed under the Boost Software License, Version 1.0. (See <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 accompanying file <a href="../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a>
copy at <a href= or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
"http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p>
</div> </div>
</body> </body>
</html> </html>