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
|
|
|
|
2022-10-15 23:40:35 +02:00
|
|
|
**Writing tests:**
|
2017-08-24 15:33:38 +02:00
|
|
|
* [Assertion macros](assertions.md#top)
|
2022-10-15 23:41:51 +02:00
|
|
|
* [Matchers (asserting complex properties)](matchers.md#top)
|
2022-10-14 22:14:52 +02:00
|
|
|
* [Comparing floating point numbers](comparing-floating-point-numbers.md#top)
|
2017-08-24 15:33:38 +02:00
|
|
|
* [Logging macros](logging.md#top)
|
|
|
|
|
* [Test cases and sections](test-cases-and-sections.md#top)
|
|
|
|
|
* [Test fixtures](test-fixtures.md#top)
|
2022-10-15 23:41:51 +02:00
|
|
|
* [Reporters (output customization)](reporters.md#top)
|
2017-08-24 15:33:38 +02:00
|
|
|
* [Event Listeners](event-listeners.md#top)
|
2022-10-15 23:41:51 +02:00
|
|
|
* [Data Generators (value parameterized tests)](generators.md#top)
|
2018-09-17 10:51:44 +02:00
|
|
|
* [Other macros](other-macros.md#top)
|
2019-06-15 09:23:00 +02:00
|
|
|
* [Micro benchmarking](benchmarks.md#top)
|
2017-03-15 10:08:20 +01:00
|
|
|
|
2022-10-15 23:40:35 +02:00
|
|
|
**Fine tuning:**
|
2017-08-24 15:33:38 +02:00
|
|
|
* [Supplying your own main()](own-main.md#top)
|
|
|
|
|
* [Compile-time configuration](configuration.md#top)
|
|
|
|
|
* [String Conversions](tostring.md#top)
|
2017-03-15 10:08:20 +01:00
|
|
|
|
2022-10-15 23:40:35 +02:00
|
|
|
**Running:**
|
2017-08-24 15:33:38 +02:00
|
|
|
* [Command line](command-line.md#top)
|
2018-06-21 23:34:17 +02:00
|
|
|
|
2022-10-15 23:40:35 +02:00
|
|
|
**Odds and ends:**
|
2021-11-19 15:23:50 +01:00
|
|
|
* [Frequently Asked Questions (FAQ)](faq.md#top)
|
2022-06-22 00:13:53 +02:00
|
|
|
* [Best practices and other tips](usage-tips.md#top)
|
2018-06-21 23:34:17 +02:00
|
|
|
* [CMake integration](cmake-integration.md#top)
|
|
|
|
|
* [CI and other miscellaneous pieces](ci-and-misc.md#top)
|
2017-08-24 15:33:38 +02:00
|
|
|
* [Known limitations](limitations.md#top)
|
2022-10-17 15:02:45 +02:00
|
|
|
|
2022-10-15 23:40:35 +02:00
|
|
|
**Other:**
|
2021-08-07 21:56:17 +02:00
|
|
|
* [Why Catch2?](why-catch.md#top)
|
2020-10-31 09:08:58 +01:00
|
|
|
* [Migrating from v2 to v3](migrate-v2-to-v3.md#top)
|
2021-08-08 17:08:37 +02:00
|
|
|
* [Open Source Projects using Catch2](opensource-users.md#top)
|
|
|
|
|
* [Commercial Projects using Catch2](commercial-users.md#top)
|
2017-08-24 15:33:38 +02:00
|
|
|
* [Contributing](contributing.md#top)
|
|
|
|
|
* [Release Notes](release-notes.md#top)
|
2018-11-24 18:01:20 +01:00
|
|
|
* [Deprecations and incoming changes](deprecations.md#top)
|
