2017-08-24 15:21:36 +02:00
|
|
|
<a id="top"></a>
|
2017-08-24 22:21:54 +02:00
|
|
|
# Reference
|
|
|
|
|
|
2017-11-03 14:05:09 +01:00
|
|
|
To get the most out of Catch2, start with the [tutorial](tutorial.md#top).
|
2017-03-15 10:08:20 +01:00
|
|
|
Once you're up and running consider the following reference material.
|
2014-08-15 14:12:53 +02:00
|
|
|
|
2023-06-11 20:31:41 +02:00
|
|
|
**Writing tests:**
|
|
|
|
|
|
|
|
|
|
- [Assertion macros](assertions.md#top)
|
|
|
|
|
- [Matchers (asserting complex properties)](matchers.md#top)
|
|
|
|
|
- [Comparing floating point numbers](comparing-floating-point-numbers.md#top)
|
|
|
|
|
- [Logging macros](logging.md#top)
|
|
|
|
|
- [Test cases and sections](test-cases-and-sections.md#top)
|
|
|
|
|
- [Test fixtures](test-fixtures.md#top)
|
|
|
|
|
- [Explicitly skipping, passing, and failing tests at runtime](skipping-passing-failing.md#top)
|
|
|
|
|
- [Reporters (output customization)](reporters.md#top)
|
|
|
|
|
- [Event Listeners](event-listeners.md#top)
|
|
|
|
|
- [Data Generators (value parameterized tests)](generators.md#top)
|
|
|
|
|
- [Other macros](other-macros.md#top)
|
|
|
|
|
- [Micro benchmarking](benchmarks.md#top)
|
|
|
|
|
|
|
|
|
|
**Fine tuning:**
|
|
|
|
|
|
|
|
|
|
- [Supplying your own main()](own-main.md#top)
|
|
|
|
|
- [Compile-time configuration](configuration.md#top)
|
|
|
|
|
- [String Conversions](tostring.md#top)
|
|
|
|
|
|
|
|
|
|
**Running:**
|
|
|
|
|
|
|
|
|
|
- [Command line](command-line.md#top)
|
|
|
|
|
|
|
|
|
|
**Odds and ends:**
|
|
|
|
|
|
|
|
|
|
- [Frequently Asked Questions (FAQ)](faq.md#top)
|
|
|
|
|
- [Best practices and other tips](usage-tips.md#top)
|
|
|
|
|
- [CMake integration](cmake-integration.md#top)
|
|
|
|
|
- [Tooling integration (CI, test runners, other)](ci-and-misc.md#top)
|
|
|
|
|
- [Known limitations](limitations.md#top)
|
|
|
|
|
|
|
|
|
|
**Other:**
|
|
|
|
|
|
|
|
|
|
- [Why Catch2?](why-catch.md#top)
|
|
|
|
|
- [Migrating from v2 to v3](migrate-v2-to-v3.md#top)
|
|
|
|
|
- [Open Source Projects using Catch2](opensource-users.md#top)
|
|
|
|
|
- [Commercial Projects using Catch2](commercial-users.md#top)
|
|
|
|
|
- [Contributing](contributing.md#top)
|
|
|
|
|
- [Release Notes](release-notes.md#top)
|
|
|
|
|
- [Deprecations and incoming changes](deprecations.md#top)
|
