forked from boostorg/preprocessor
lib cleanup
[SVN r15693]
This commit is contained in:
55
doc/ref/assert_msg.html
Normal file
55
doc/ref/assert_msg.html
Normal file
@ -0,0 +1,55 @@
|
||||
<html>
|
||||
<head>
|
||||
<title>BOOST_PP_ASSERT_MSG</title>
|
||||
<link rel="stylesheet" type="text/css" href="../styles.css">
|
||||
</head>
|
||||
<body>
|
||||
<div style="margin-left: 0px;">
|
||||
The <b>BOOST_PP_ASSERT_MSG</b> macro conditionally inserts debugging text.
|
||||
</div>
|
||||
<h4>Usage</h4>
|
||||
<div class="code">
|
||||
<b>BOOST_PP_ASSERT_MSG</b>(<i>cond</i>, <i>msg</i>)
|
||||
</div>
|
||||
<h4>Arguments</h4>
|
||||
<dl>
|
||||
<dt>cond</dt>
|
||||
<dd>
|
||||
A condition that determines whether an assertion occurs.
|
||||
Valid values range from <i>0</i> to <b>BOOST_PP_LIMIT_MAG</b>.
|
||||
</dd>
|
||||
<dt>msg</dt>
|
||||
<dd>
|
||||
A message to display if <i>cond</i> evaluates to <i>0</i>.
|
||||
</dd>
|
||||
</dl>
|
||||
<h4>Remarks</h4>
|
||||
<div>
|
||||
If <i>cond</i> expands to <i>0</i>, this macro expands to <i>msg</i>.
|
||||
Otherwise, it expands to nothing.
|
||||
</div>
|
||||
<h4>See Also</h4>
|
||||
<ul>
|
||||
<li><a href="assert_msg.html">BOOST_PP_ASSERT_MSG</a></li>
|
||||
<li><a href="limit_mag.html">BOOST_PP_LIMIT_MAG</a></li>
|
||||
</ul>
|
||||
<h4>Requirements</h4>
|
||||
<div>
|
||||
<b>Header:</b> <a href="../headers/debug/assert.hpp.html"><boost/preprocessor/debug/assert.hpp></a>
|
||||
</div>
|
||||
<h4>Sample Code</h4>
|
||||
<div><pre>
|
||||
#include <<a href="../headers/comparison/equal.hpp.html">boost/preprocessor/comparison/equal.hpp</a>>
|
||||
#include <<a href="../headers/debug/assert.hpp.html">boost/preprocessor/debug/assert.hpp</a>>
|
||||
|
||||
// lines are supposed to be counted
|
||||
// in translation phase 1
|
||||
|
||||
#line 9
|
||||
<a href="assert_msg.html">BOOST_PP_ASSERT_MSG</a>( \
|
||||
BOOST_PP_EQUAL(__LINE__, 9), \
|
||||
"incorrect line numbering detected" \
|
||||
)
|
||||
</pre></div>
|
||||
</body>
|
||||
</html>
|
Reference in New Issue
Block a user