From bc524d70253a4ab2fe40c3ca3e5666e267c0a4d1 Mon Sep 17 00:00:00 2001 From: Lexi Winter Date: Sun, 29 Jun 2025 19:25:29 +0100 Subject: import catch2 3.8.1 --- docs/list-of-examples.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 docs/list-of-examples.md (limited to 'docs/list-of-examples.md') diff --git a/docs/list-of-examples.md b/docs/list-of-examples.md new file mode 100644 index 0000000..40d3f71 --- /dev/null +++ b/docs/list-of-examples.md @@ -0,0 +1,47 @@ + +# List of examples + +## Already available + +- Test Case: [Single-file](../examples/010-TestCase.cpp) +- Test Case: [Multiple-file 1](../examples/020-TestCase-1.cpp), [2](../examples/020-TestCase-2.cpp) +- Assertion: [REQUIRE, CHECK](../examples/030-Asn-Require-Check.cpp) +- Fixture: [Sections](../examples/100-Fix-Section.cpp) +- Fixture: [Class-based fixtures](../examples/110-Fix-ClassFixture.cpp) +- Fixture: [Persistent fixtures](../examples/111-Fix-PersistentFixture.cpp) +- BDD: [SCENARIO, GIVEN, WHEN, THEN](../examples/120-Bdd-ScenarioGivenWhenThen.cpp) +- Listener: [Listeners](../examples/210-Evt-EventListeners.cpp) +- Configuration: [Provide your own output streams](../examples/231-Cfg-OutputStreams.cpp) +- Generators: [Create your own generator](../examples/300-Gen-OwnGenerator.cpp) +- Generators: [Use map to convert types in GENERATE expression](../examples/301-Gen-MapTypeConversion.cpp) +- Generators: [Run test with a table of input values](../examples/302-Gen-Table.cpp) +- Generators: [Use variables in generator expressions](../examples/310-Gen-VariablesInGenerators.cpp) +- Generators: [Use custom variable capture in generator expressions](../examples/311-Gen-CustomCapture.cpp) + + +## Planned + +- Assertion: [REQUIRE_THAT and Matchers](../examples/040-Asn-RequireThat.cpp) +- Assertion: [REQUIRE_NO_THROW](../examples/050-Asn-RequireNoThrow.cpp) +- Assertion: [REQUIRE_THROWS](../examples/050-Asn-RequireThrows.cpp) +- Assertion: [REQUIRE_THROWS_AS](../examples/070-Asn-RequireThrowsAs.cpp) +- Assertion: [REQUIRE_THROWS_WITH](../examples/080-Asn-RequireThrowsWith.cpp) +- Assertion: [REQUIRE_THROWS_MATCHES](../examples/090-Asn-RequireThrowsMatches.cpp) +- Floating point: [Approx - Comparisons](../examples/130-Fpt-Approx.cpp) +- Logging: [CAPTURE - Capture expression](../examples/140-Log-Capture.cpp) +- Logging: [INFO - Provide information with failure](../examples/150-Log-Info.cpp) +- Logging: [WARN - Issue warning](../examples/160-Log-Warn.cpp) +- Logging: [FAIL, FAIL_CHECK - Issue message and force failure/continue](../examples/170-Log-Fail.cpp) +- Logging: [SUCCEED - Issue message and continue](../examples/180-Log-Succeed.cpp) +- Report: [User-defined type](../examples/190-Rpt-ReportUserDefinedType.cpp) +- Report: [User-defined reporter](../examples/202-Rpt-UserDefinedReporter.cpp) +- Report: [Automake reporter](../examples/205-Rpt-AutomakeReporter.cpp) +- Report: [TAP reporter](../examples/206-Rpt-TapReporter.cpp) +- Report: [Multiple reporter](../examples/208-Rpt-MultipleReporters.cpp) +- Configuration: [Provide your own main()](../examples/220-Cfg-OwnMain.cpp) +- Configuration: [Compile-time configuration](../examples/230-Cfg-CompileTimeConfiguration.cpp) +- Configuration: [Run-time configuration](../examples/240-Cfg-RunTimeConfiguration.cpp) + +--- + +[Home](Readme.md#top) -- cgit v1.2.3