testout_reference.qbk 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  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. [section:testout_reference Controlling tests outputs]
  9. [/ -------------------------------------------------------------------------------------------------- ]
  10. [section:test_output_macro_checkpoint `BOOST_TEST_CHECKPOINT`]
  11. Sets up a named check point.
  12. [tip See the [link boost_test.test_output.test_tools_support_for_logging.checkpoints checkpoint] section for more details.]
  13. [endsect]
  14. [section:test_output_macro_passpoint `BOOST_TEST_PASSPOINT`]
  15. Sets up an unnamed check point.
  16. [tip See the [link boost_test.test_output.test_tools_support_for_logging.checkpoints checkpoint] section for more details.]
  17. [endsect]
  18. [section:test_output_macro_message `BOOST_TEST_MESSAGE`]
  19. Outputs a custom message into the test log.
  20. [tip See the [link boost_test.test_output.test_tools_support_for_logging.test_output_macro_message corresponding] section for more details.]
  21. [endsect]
  22. [section:test_output_macro_info `BOOST_TEST_INFO`]
  23. Defines a message to be printed as part of the context of the first encountered assertion, if it fails.
  24. For more details see [link boost_test.test_output.test_tools_support_for_logging.contexts here].
  25. [endsect]
  26. [section:test_output_macro_context `BOOST_TEST_CONTEXT`]
  27. Defines a scope and a message to be printed as part of the context of every failed assertion within the scope.
  28. For more details see [link boost_test.test_output.test_tools_support_for_logging.contexts here].
  29. [endsect]
  30. [section:test_output_macro_context_sticky `BOOST_TEST_INFO_SCOPE`]
  31. Defines a sticky version of __BOOST_TEST_INFO__: the message stored in `BOOST_TEST_INFO_SCOPE` is printed for all failed assertions that come
  32. after the declaration of `BOOST_TEST_INFO_SCOPE` and within the current scope.
  33. For more details see [link boost_test.test_output.test_tools_support_for_logging.contexts here].
  34. [endsect]
  35. [section:test_output_macro_disable_type `BOOST_TEST_DONT_PRINT_LOG_VALUE`]
  36. Disables the automatic printing of a value. This macro is relevant
  37. * a type is used in a comparison assertion (such as __BOOST_LEVEL_GE__ for instance)
  38. * when the type being compared does not implement a suitable `operator <<` for streaming out the value into the
  39. test log stream
  40. [tip See the [link boost_test.test_output.test_tools_support_for_logging.testing_tool_output_disable corresponding] section for more details.]
  41. [endsect]
  42. [endsect]