3rd-party/catch2
1
0
Fork 0
mirror of https://github.com/catchorg/Catch2.git synced 2024-12-23 03:43:28 +01:00
Code Issues Packages Projects Releases Wiki Activity
3c06bcb374
catch2/docs
History
Martin Hořeňovský 1a8a793178
Refactor colour handling to prepare for per-reporter colour modes 
This includes always compiling the ANSI and None colour
implementations, as they don't need to touch any platform
specific APIs, and removing their respective compile-time
configuration options.

Because the Win32 colour implementation requires Win32-specific
APIs, it is still hidden behind a compile-time toggle,
`CATCH_CONFIG_COLOUR_WIN32` (renamed from `..._COLOUR_WINDOWS`).

The commandline options for colours were also changed. The
option now uses different name, and allows to select between
different implementations, rather than changing whether
the compiled-in colour implementation is used through
"yes/no/default" options.
2022-03-28 13:10:13 +02:00
..
assertions.md Improve the REQUIRE_THROWS_MATCHES documentation a bit 2019-07-29 20:39:02 +02:00
benchmarks.md Mention that run == iteration in benchmarking docs 2021-11-15 23:09:18 +01:00
ci-and-misc.md Rename contrib/ to extras/ in the docs 2021-08-10 10:41:16 +02:00
cmake-integration.md Fix mentions of CATCH_INSTALL_HELPERS 2022-01-06 23:37:44 +01:00
command-line.md Refactor colour handling to prepare for per-reporter colour modes 2022-03-28 13:10:13 +02:00
commercial-users.md Update users docs 2021-08-08 23:42:24 +02:00
configuration.md Refactor colour handling to prepare for per-reporter colour modes 2022-03-28 13:10:13 +02:00
contributing.md Add tests for CMake configure toggles passing to Catch2 build 2022-02-20 19:32:30 +01:00
deprecations.md Suppress failure of CHECKED_IF and CHECKED_ELSE (#2187) 2021-05-10 21:42:47 +02:00
event-listeners.md Fix link in event-listeners.md 2021-11-22 11:44:36 +01:00
faq.md Add FAQ page to the documentation 2021-11-19 15:23:50 +01:00
generators.md Mention that RangeGenerator works on half open ranges 2021-11-15 23:52:26 +01:00
limitations.md Update known-limitations.md 2021-11-19 00:32:59 +01:00
list-of-examples.md Examples: remove references to catch_default_main 2022-02-20 13:10:42 +01:00
logging.md Fix introduced in version placeholders 2021-03-13 10:26:12 +01:00
matchers.md Rename Contains string matcher builder to ContainsSubstring 2021-09-27 21:28:33 +02:00
migrate-v2-to-v3.md Add major changes and their motivation to v2 -> v3 migration docs 2021-07-29 23:19:48 +02:00
opensource-users.md Add eventpp and accessorpp to Catch2 users 2022-03-13 16:56:07 +01:00
other-macros.md Add STATIC_CHECK and STATIC_CHECK_FALSE (#2318) 2021-11-15 00:28:27 +01:00
own-main.md Rewrite own-main.md for v3 2021-11-19 15:52:32 +01:00
Readme.md Add FAQ page to the documentation 2021-11-19 15:23:50 +01:00
release-notes.md Refactor colour handling to prepare for per-reporter colour modes 2022-03-28 13:10:13 +02:00
release-process.md Update release-process.md for v3 2022-01-03 23:30:39 +01:00
reporter-events.md Rename reportInvalidArguments -> reportInvalidTestSpec 2021-12-18 20:49:50 +01:00
reporters.md Add common ReporterBase as parent of the helper bases 2022-03-06 16:28:22 +01:00
test-cases-and-sections.md Add more tests for various less common tag-related cases 2021-12-28 00:22:53 +01:00
test-fixtures.md Fix introduced in version placeholders 2021-03-13 10:26:12 +01:00
tostring.md Fix introduced in version placeholders 2021-03-13 10:26:12 +01:00
tutorial.md Rewrite tutorial to shorten BDD section and mention generators 2021-11-16 23:46:23 +01:00
why-catch.md Update why-catch.md 2021-08-08 23:42:17 +02:00

Readme.md

Reference

To get the most out of Catch2, start with the tutorial. Once you're up and running consider the following reference material.

Writing tests:

Fine tuning:

Running:

Odds and ends:

Other: