How to read this documentation

This documentation is structured by what you, as a user, need to know to successfully use the Unit Test Framework and the order of decisions you have to make and order of complexity of the problems you might encounter. If you ever find yourself facing with some unclear term feel free to jump directly to the glossary section, where short definitions for all used terms were collected.

Typically, when writing a test module using the Unit Test Framework you have to go through the following steps:

You decide how you want to incorporate the Unit Test Framework: #include it as a header-only library, or link with it as a static library, or use it as a shared (or dynamically loaded) library. For details on this topic see section Usage variants.
You add a test case into a test tree. For details, see section Test cases.
You perform correctness checks of the code under tested. For details, see section Writing unit tests.
You perform the initialization of code under test before each test case. For details, see section Fixtures.
You might want to customize the way test failures are reported. For details, see section Controlling output.
You can control the run-time behavior of the built test module (e.g., run only selected tests, change the output format). This is covered in section Runtime configuration.

If you can't find answer to your question in any of the section mentioned above or if you believe you need even more configuration options, you can check Advanced usage scenarios section.

Boost C++ Libraries

How to read this documentation