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

Updated documentation for tuples.

Browse Source 
[SVN r86788]
This commit is contained in:
Edward Diener
2013-11-23 03:59:40 +00:00
parent e9bdfe5276
commit b03b732a19
22 changed files with 653 additions and 591 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/ref/tuple_insert.html
View File

@ -8,7 +8,8 @@
<div style="margin-left: 0px;"> The <b>BOOST_PP_TUPLE_INSERT</b> macro
inserts an element into an <i>tuple</i>.</div>
<h4>Usage</h4>
<div class="code"> <b>BOOST_PP_TUPLE_INSERT</b>(<i>tuple</i>, <i>i</i>, <i>elem</i>)</div>
<div class="code"> <b>BOOST_PP_TUPLE_INSERT</b>(<i>tuple</i>, <i>i</i>, <i>elem</i>)
<a href="../topics/variadic_macros.html#VNotation"><sup>(v)</sup></a></div>
<h4>Arguments</h4>
<dl>
<dt>tuple</dt>

2
doc/ref/tuple_insert_d.html
View File

@ -10,7 +10,7 @@
with maximum efficiency.</div>
<h4>Usage</h4>
<div class="code"> <b>BOOST_PP_TUPLE_INSERT_D</b>(<i>d</i>, <i>tuple</i>,
<i>i</i>, <i>elem</i>)</div>
<i>i</i>, <i>elem</i>) <a href="../topics/variadic_macros.html#VNotation"><sup>(v)</sup></a></div>
<h4>Arguments</h4>
<dl>
<dt>d</dt>

2
doc/ref/tuple_pop_back.html
View File

@ -8,7 +8,7 @@
<div style="margin-left: 0px;"> The <b>BOOST_PP_TUPLE_POP_BACK</b> macro
pops an element from the end of an <i>tuple</i>.</div>
<h4>Usage</h4>
<div class="code"> <b>BOOST_PP_TUPLE_POP_BACK</b>(<i>tuple</i>)</div>
<div class="code"> <b>BOOST_PP_TUPLE_POP_BACK</b>(<i>tuple</i>) <a href="../topics/variadic_macros.html#VNotation"><sup>(v)</sup></a></div>
<h4>Arguments</h4>
<dl>
<dt>tuple</dt>

8
doc/ref/tuple_pop_back_z.html
View File

@ -9,7 +9,8 @@
pops an element from the end of an <i>tuple</i>.&nbsp; It reenters <b>BOOST_PP_REPEAT</b>
with maximum efficiency. </div>
<h4>Usage</h4>
<div class="code"> <b>BOOST_PP_TUPLE_POP_BACK_Z</b>(<i>z</i>, <i>tuple</i>)</div>
<div class="code"> <b>BOOST_PP_TUPLE_POP_BACK_Z</b>(<i>z</i>, <i>tuple</i>)
<a href="../topics/variadic_macros.html#VNotation"><sup>(v)</sup></a></div>
<h4>Arguments</h4>
<dl>
<dt>z</dt>
@ -19,9 +20,8 @@
</dl>
<h4>Remarks</h4>
<div> This macro returns <i>tuple</i> after removing the last
element.&nbsp;
If <i>tuple</i> has only a single element, it remains unchanged since
a&nbsp;<i>tuple </i>must have at least one element.</div>
element.&nbsp; If <i>tuple</i> has only a single element, it remains
unchanged since a&nbsp;<i>tuple </i>must have at least one element.</div>
<h4>See Also</h4>
<ul>
<li><a href="tuple_pop_back.html">BOOST_PP_TUPLE_POP_BACK</a></li>

7
doc/ref/tuple_pop_front.html
View File

@ -8,7 +8,7 @@
<div style="margin-left: 0px;"> The <b>BOOST_PP_TUPLE_POP_FRONT</b> macro
pops an element from the beginning of a <i>tuple</i>.</div>
<h4>Usage</h4>
<div class="code"> <b>BOOST_PP_TUPLE_POP_FRONT</b>(<i>tuple</i>)</div>
<div class="code"> <b>BOOST_PP_TUPLE_POP_FRONT</b>(<i>tuple</i>) <a href="../topics/variadic_macros.html#VNotation"><sup>(v)</sup></a></div>
<h4>Arguments</h4>
<dl>
<dt>tuple</dt>
@ -16,9 +16,8 @@
</dl>
<h4>Remarks</h4>
<div> This macro returns <i>tuple</i> after removing the first
element.&nbsp;
If <i>tuple</i> has only a single element, it remains unchanged since
a&nbsp;<i>tuple </i>must have at least one element.</div>
element.&nbsp; If <i>tuple</i> has only a single element, it remains
unchanged since a&nbsp;<i>tuple </i>must have at least one element.</div>
<div> This macro uses <b>BOOST_PP_REPEAT</b> internally.&nbsp; Therefore,
to use the <i>z</i> parameter passed from other macros that use <b>BOOST_PP_REPEAT</b>,
see <b>BOOST_PP_TUPLE_POP_FRONT_Z</b> </div>

3
doc/ref/tuple_pop_front_z.html
View File

@ -9,7 +9,8 @@
macro pops an element from the beginning of a&nbsp;<i>tuple</i>.&nbsp; It
reenters <b>BOOST_PP_REPEAT</b> with maximum efficiency.</div>
<h4>Usage</h4>
<div class="code"> <b>BOOST_PP_TUPLE_POP_FRONT_Z</b>(<i>z</i>, <i>tuple</i>)</div>
<div class="code"> <b>BOOST_PP_TUPLE_POP_FRONT_Z</b>(<i>z</i>, <i>tuple</i>)
<a href="../topics/variadic_macros.html#VNotation"><sup>(v)</sup></a></div>
<h4>Arguments</h4>
<dl>
<dt>z</dt>

3
doc/ref/tuple_push_back.html
View File

@ -8,7 +8,8 @@
<div style="margin-left: 0px;"> The <b>BOOST_PP_TUPLE_PUSH_BACK</b> macro
appends an element to the end of a <i>tuple</i>.</div>
<h4>Usage</h4>
<div class="code"> <b>BOOST_PP_TUPLE_PUSH_BACK</b>(<i>tuple</i>, <i>elem</i>)</div>
<div class="code"> <b>BOOST_PP_TUPLE_PUSH_BACK</b>(<i>tuple</i>, <i>elem</i>)
<a href="../topics/variadic_macros.html#VNotation"><sup>(v)</sup></a></div>
<h4>Arguments</h4>
<dl>
<dt>tuple</dt>

3
doc/ref/tuple_push_front.html
View File

@ -8,7 +8,8 @@
<div style="margin-left: 0px;"> The <b>BOOST_PP_TUPLE_PUSH_FRONT</b> macro
appends an element to the beginning of a <i>tuple</i>.</div>
<h4>Usage</h4>
<div class="code"> <b>BOOST_PP_TUPLE_PUSH_FRONT</b>(<i>tuple</i>, <i>elem</i>)</div>
<div class="code"> <b>BOOST_PP_TUPLE_PUSH_FRONT</b>(<i>tuple</i>, <i>elem</i>)
<a href="../topics/variadic_macros.html#VNotation"><sup>(v)</sup></a></div>
<h4>Arguments</h4>
<dl>
<dt>tuple</dt>

3
doc/ref/tuple_remove.html
View File

@ -8,7 +8,8 @@
<div style="margin-left: 0px;"> The <b>BOOST_PP_TUPLE_REMOVE</b> macro
removes an element from a <i>tuple</i>.</div>
<h4>Usage</h4>
<div class="code"> <b>BOOST_PP_TUPLE_REMOVE</b>(<i>tuple</i>, <i>i</i>)</div>
<div class="code"> <b>BOOST_PP_TUPLE_REMOVE</b>(<i>tuple</i>, <i>i</i>) <a
href="../topics/variadic_macros.html#VNotation"><sup>(v)</sup></a></div>
<h4>Arguments</h4>
<dl>
<dt>tuple</dt>

2
doc/ref/tuple_remove_d.html
View File

@ -10,7 +10,7 @@
with maximum efficiency. </div>
<h4>Usage</h4>
<div class="code"> <b>BOOST_PP_TUPLE_REMOVE_D</b>(<i>d</i>, <i>tuple</i>,
<i>i</i>)</div>
<i>i</i>) <a href="../topics/variadic_macros.html#VNotation"><sup>(v)</sup></a></div>
<h4>Arguments</h4>
<dl>
<dt>d</dt>

3
doc/ref/tuple_replace.html
View File

@ -8,7 +8,8 @@
<div style="margin-left: 0px;"> The <b>BOOST_PP_TUPLE_REPLACE</b> macro
replaces an element in a <i>tuple</i>.</div>
<h4>Usage</h4>
<div class="code"> <b>BOOST_PP_TUPLE_REPLACE</b>(<i>tuple</i>, <i>i</i>, <i>elem</i>)</div>
<div class="code"> <b>BOOST_PP_TUPLE_REPLACE</b>(<i>tuple</i>, <i>i</i>, <i>elem</i>)
<a href="../topics/variadic_macros.html#VNotation"><sup>(v)</sup></a></div>
<h4>Arguments</h4>
<dl>
<dt>tuple</dt>

2
doc/ref/tuple_replace_d.html
View File

@ -10,7 +10,7 @@
with maximum efficiency.</div>
<h4>Usage</h4>
<div class="code"> <b>BOOST_PP_TUPLE_REPLACE_D</b>(<i>d</i>, <i>tuple</i>,
<i>i</i>, <i>elem</i>)</div>
<i>i</i>, <i>elem</i>) <a href="../topics/variadic_macros.html#VNotation"><sup>(v)</sup></a></div>
<h4>Arguments</h4>
<dl>
<dt>d</dt>