2
0
mirror of https://github.com/boostorg/test.git synced 2026-01-29 20:12:09 +00:00
Files
test/doc/test_output/reference.qbk
Raffi Enficiaud 6747ff0d1a License
2015-02-03 02:15:31 +01:00

93 lines
2.9 KiB
Plaintext

[/
/ Copyright (c) 2003-2014 Gennadiy Rozental
/ Copyright (c) 2015 Raffi Enficiaud
/
/ Distributed under the Boost Software License, Version 1.0. (See accompanying
/ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
/]
[section:reference Reference]
[table
[
[Macro]
[Short description]
]
[/ ###############################################################################################]
[
[__BOOST_TEST_MESSAGE__]
[Custom message output]
]
[
[__BOOST_TEST_DONT_PRINT_LOG_VALUE__]
[Disabling the printing of a specific type in case of test failure]
]
[
[__BOOST_TEST_CHECKPOINT__]
[Indicates a named checkpoint that will be printed in case of failure]
]
[
[__BOOST_TEST_PASSPOINT__]
[Indicates an unnamed checkpoint that will be printed in case of failure]
]
[
[__BOOST_TEST_INFO__]
[Defines a message to be printed as part of the context of the first encountered assertion, if it fails]
]
[
[__BOOST_TEST_CONTEXT__]
[Defines a scope and a message to be printed as part of the context of every failed assertion within the scope]
]
]
[/ -------------------------------------------------------------------------------------------------- ]
[section:test_output_macro_checkpoint `BOOST_TEST_CHECKPOINT`]
Sets up a named check point.
[tip See the [link boost_test.users_guide.test_output.checkpoints checkpoint] section for more details.]
[endsect]
[section:test_output_macro_passpoint `BOOST_TEST_PASSPOINT`]
Sets up an unnamed check point.
[tip See the [link boost_test.users_guide.test_output.checkpoints checkpoint] section for more details.]
[endsect]
[section:test_output_macro_message `BOOST_TEST_MESSAGE`]
Outputs a custom message into the test log.
[tip See the [link boost_test.users_guide.test_output.test_output_macro_message corresponding] section for more details.]
[endsect]
[section:test_output_macro_info `BOOST_TEST_INFO`]
Defines a message to be printed as part of the context of the first encountered assertion, if it fails. For more details see [link boost_test.users_guide.test_output.contexts here].
[endsect]
[section:test_output_macro_context `BOOST_TEST_CONTEXT`]
Defines a scope and a message to be printed as part of the context of every failed assertion within the scope. For more details see [link boost_test.users_guide.test_output.contexts here].
[endsect]
[section:test_output_macro_disable_type `BOOST_TEST_DONT_PRINT_LOG_VALUE`]
Disables the automatic printing of a value. This macro is relevant
* a type is used in a comparison assertion (such as __BOOST_LEVEL_GE__ for instance)
* when the type being compared does not implement a suitable `operator <<` for streaming out the value into the
test log stream
[tip See the [link boost_test.users_guide.test_output.testing_tool_output_disable corresponding] section for more details.]
[endsect]
[endsect]