libs/test/doc/html/boost_test/test_output/summary.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Summary of the API for controlling the output</title>
   5 <link rel="stylesheet" href="../../boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../index.html" title="Boost.Test">
   8 <link rel="up" href="../test_output.html" title="Controlling outputs">
   9 <link rel="prev" href="test_output_progress.html" title="Progress display">
  10 <link rel="next" href="../runtime_config.html" title="Runtime parameters">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="test_output_progress.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../test_output.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../runtime_config.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h3 class="title">
  27 <a name="boost_test.test_output.summary"></a><a class="link" href="summary.html" title="Summary of the API for controlling the output">Summary of the API for
  28       controlling the output</a>
  29 </h3></div></div></div>
  30 <div class="informaltable"><table class="table">
  31 <colgroup>
  32 <col>
  33 <col>
  34 </colgroup>
  35 <thead><tr>
  36 <th>
  37                 <p>
  38                   Macro
  39                 </p>
  40               </th>
  41 <th>
  42                 <p>
  43                   Short description
  44                 </p>
  45               </th>
  46 </tr></thead>
  47 <tbody>
  48 <tr>
  49 <td>
  50                 <p>
  51                   <a class="link" href="../utf_reference/testout_reference/test_output_macro_message.html" title="BOOST_TEST_MESSAGE"><code class="computeroutput"><span class="identifier">BOOST_TEST_MESSAGE</span></code></a>
  52                 </p>
  53               </td>
  54 <td>
  55                 <p>
  56                   Custom message output
  57                 </p>
  58               </td>
  59 </tr>
  60 <tr>
  61 <td>
  62                 <p>
  63                   <a class="link" href="../utf_reference/testout_reference/test_output_macro_disable_type.html" title="BOOST_TEST_DONT_PRINT_LOG_VALUE"><code class="computeroutput"><span class="identifier">BOOST_TEST_DONT_PRINT_LOG_VALUE</span></code></a>
  64                 </p>
  65               </td>
  66 <td>
  67                 <p>
  68                   Disabling the printing of a specific type in case of test failure
  69                 </p>
  70               </td>
  71 </tr>
  72 <tr>
  73 <td>
  74                 <p>
  75                   <a class="link" href="../utf_reference/testout_reference/test_output_macro_checkpoint.html" title="BOOST_TEST_CHECKPOINT"><code class="computeroutput"><span class="identifier">BOOST_TEST_CHECKPOINT</span></code></a>
  76                 </p>
  77               </td>
  78 <td>
  79                 <p>
  80                   Indicates a named checkpoint that will be printed in case of failure
  81                 </p>
  82               </td>
  83 </tr>
  84 <tr>
  85 <td>
  86                 <p>
  87                   <a class="link" href="../utf_reference/testout_reference/test_output_macro_passpoint.html" title="BOOST_TEST_PASSPOINT"><code class="computeroutput"><span class="identifier">BOOST_TEST_PASSPOINT</span></code></a>
  88                 </p>
  89               </td>
  90 <td>
  91                 <p>
  92                   Indicates an unnamed checkpoint that will be printed in case of
  93                   failure
  94                 </p>
  95               </td>
  96 </tr>
  97 <tr>
  98 <td>
  99                 <p>
 100                   <a class="link" href="../utf_reference/testout_reference/test_output_macro_info.html" title="BOOST_TEST_INFO"><code class="computeroutput"><span class="identifier">BOOST_TEST_INFO</span></code></a>
 101                 </p>
 102               </td>
 103 <td>
 104                 <p>
 105                   Defines a message to be printed as part of the context of the first
 106                   encountered assertion, if it fails
 107                 </p>
 108               </td>
 109 </tr>
 110 <tr>
 111 <td>
 112                 <p>
 113                   <a class="link" href="../utf_reference/testout_reference/test_output_macro_context.html" title="BOOST_TEST_CONTEXT"><code class="computeroutput"><span class="identifier">BOOST_TEST_CONTEXT</span></code></a>
 114                 </p>
 115               </td>
 116 <td>
 117                 <p>
 118                   Defines a scope and a message to be printed as part of the context
 119                   of every failed assertion within the scope
 120                 </p>
 121               </td>
 122 </tr>
 123 <tr>
 124 <td>
 125                 <p>
 126                   <a class="link" href="../utf_reference/testout_reference/test_output_macro_context_sticky.html" title="BOOST_TEST_INFO_SCOPE"><code class="computeroutput"><span class="identifier">BOOST_TEST_INFO_SCOPE</span></code></a>
 127                 </p>
 128               </td>
 129 <td>
 130                 <p>
 131                   Defines a sticky scoped version of <a class="link" href="../utf_reference/testout_reference/test_output_macro_info.html" title="BOOST_TEST_INFO"><code class="computeroutput"><span class="identifier">BOOST_TEST_INFO</span></code></a> that is
 132                   attached to all the assertions coming after this declaration and
 133                   within the current scope.
 134                 </p>
 135               </td>
 136 </tr>
 137 </tbody>
 138 </table></div>
 139 </div>
 140 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 141 <td align="left"></td>
 142 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
 143       contributors<p>
 144         Distributed under the Boost Software License, Version 1.0. (See accompanying
 145         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 146       </p>
 147 </div></td>
 148 </tr></table>
 149 <hr>
 150 <div class="spirit-nav">
 151 <a accesskey="p" href="test_output_progress.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../test_output.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../runtime_config.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 152 </div>
 153 </body>
 154 </html>