Added a sentence with a brief explanation of the intended uses of BOOST_VERIFY.

[SVN r40731]
This commit is contained in:
Peter Dimov 2007-11-03 22:47:17 +00:00
parent 56b0846099
commit ea8c99b1d5

View File

@ -47,13 +47,15 @@ void assertion_failed(char const * expr, char const * function, char const * fil
<P>As is the case with <STRONG>&lt;cassert&gt;</STRONG>, <STRONG>&lt;boost/assert.hpp&gt;</STRONG> <P>As is the case with <STRONG>&lt;cassert&gt;</STRONG>, <STRONG>&lt;boost/assert.hpp&gt;</STRONG>
can be included multiple times in a single translation unit. <STRONG>BOOST_ASSERT</STRONG> can be included multiple times in a single translation unit. <STRONG>BOOST_ASSERT</STRONG>
will be redefined each time as specified above.</P> will be redefined each time as specified above.</P>
<p><STRONG>&lt;boost/assert.hpp&gt;</STRONG> also defines the macro <STRONG>BOOST_VERIFY</STRONG>. <p><STRONG>&lt;boost/assert.hpp&gt;</STRONG> also defines the macro <STRONG>BOOST_VERIFY</STRONG>.
It has exactly the same behavior as <STRONG>BOOST_ASSERT</STRONG>, except It has exactly the same behavior as <STRONG>BOOST_ASSERT</STRONG>, except that
that the expression that is passed to <STRONG>BOOST_VERIFY</STRONG> is always the expression that is passed to <STRONG>BOOST_VERIFY</STRONG> is always
evaluated.</p> evaluated. This is useful when the asserted expression has desirable side
effects; it can also help suppress warnings about unused variables when the
only use of the variable is inside an assertion.</p>
<p><br> <p><br>
<small>Copyright © 2002, 2007 by Peter Dimov. Distributed under the Boost <small>Copyright © 2002, 2007 by Peter Dimov. Distributed under the Boost Software
Software License, Version 1.0. See accompanying file <A href="../../LICENSE_1_0.txt"> License, Version 1.0. See accompanying file <A href="../../LICENSE_1_0.txt">LICENSE_1_0.txt</A>
LICENSE_1_0.txt</A> or copy at <A href="http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</A>.</small></p> or copy at <A href="http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</A>.</small></p>
</body> </body>
</html> </html>