• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[/
2 / Copyright (c) 2003 Boost.Test contributors
3 / Copyright (c) 2015 Raffi Enficiaud
4 /
5 / Distributed under the Boost Software License, Version 1.0. (See accompanying
6 / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
7 /]
8
9[section:testout_reference Controlling tests outputs]
10
11
12
13[/ -------------------------------------------------------------------------------------------------- ]
14[section:test_output_macro_checkpoint `BOOST_TEST_CHECKPOINT`]
15Sets up a named check point.
16
17[tip See the [link boost_test.test_output.test_tools_support_for_logging.checkpoints checkpoint] section for more details.]
18[endsect]
19
20
21
22[section:test_output_macro_passpoint `BOOST_TEST_PASSPOINT`]
23Sets up an unnamed check point.
24
25[tip See the [link boost_test.test_output.test_tools_support_for_logging.checkpoints checkpoint] section for more details.]
26[endsect]
27
28
29
30[section:test_output_macro_message `BOOST_TEST_MESSAGE`]
31Outputs a custom message into the test log.
32
33[tip See the [link boost_test.test_output.test_tools_support_for_logging.test_output_macro_message corresponding] section for more details.]
34
35[endsect]
36
37[section:test_output_macro_info `BOOST_TEST_INFO`]
38Defines a message to be printed as part of the context of the first encountered assertion, if it fails.
39For more details see [link boost_test.test_output.test_tools_support_for_logging.contexts here].
40[endsect]
41
42[section:test_output_macro_context `BOOST_TEST_CONTEXT`]
43Defines a scope and a message to be printed as part of the context of every failed assertion within the scope.
44For more details see [link boost_test.test_output.test_tools_support_for_logging.contexts here].
45[endsect]
46
47[section:test_output_macro_context_sticky `BOOST_TEST_INFO_SCOPE`]
48Defines a sticky version of __BOOST_TEST_INFO__: the message stored in `BOOST_TEST_INFO_SCOPE` is printed for all failed assertions that come
49after the declaration of `BOOST_TEST_INFO_SCOPE` and within the current scope.
50For more details see [link boost_test.test_output.test_tools_support_for_logging.contexts here].
51[endsect]
52
53[section:test_output_macro_disable_type `BOOST_TEST_DONT_PRINT_LOG_VALUE`]
54Disables the automatic printing of a value. This macro is relevant
55
56* a type is used in a comparison assertion (such as __BOOST_LEVEL_GE__ for instance)
57* when the type being compared does not implement a suitable `operator <<` for streaming out the value into the
58  test log stream
59
60[tip See the [link boost_test.test_output.test_tools_support_for_logging.testing_tool_output_disable corresponding] section for more details.]
61
62
63[endsect]
64
65[endsect]
66