catch2/docs/list-of-examples.md

<a id="top"></a>
# 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)
- 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)
Add list of examples to documentation 2017-10-14 10:59:14 +02:00			`<a id="top"></a>`
			`# List of examples`

Split list of examples into "done" and "planned". Closes #1282 2018-05-09 22:49:04 +02:00			`## Already available`

Add list of examples to documentation 2017-10-14 10:59:14 +02:00			`- Test Case: [Single-file](../examples/010-TestCase.cpp)`
Fix the second Multiple-file example file link Previously it pointed to the first file as well. 2018-07-09 12:14:44 +02:00			`- Test Case: [Multiple-file 1](../examples/020-TestCase-1.cpp), [2](../examples/020-TestCase-2.cpp)`
Add list of examples to documentation 2017-10-14 10:59:14 +02:00			`- Assertion: [REQUIRE, CHECK](../examples/030-Asn-Require-Check.cpp)`
Split list of examples into "done" and "planned". Closes #1282 2018-05-09 22:49:04 +02:00			`- Fixture: [Sections](../examples/100-Fix-Section.cpp)`
			`- Fixture: [Class-based fixtures](../examples/110-Fix-ClassFixture.cpp)`
			`- BDD: [SCENARIO, GIVEN, WHEN, THEN](../examples/120-Bdd-ScenarioGivenWhenThen.cpp)`
			`- Listener: [Listeners](../examples/210-Evt-EventListeners.cpp)`
Add an example on providing streams with `CATCH_CONFIG_NOSTDOUT` Related to #1037 Closes #1290 2018-07-08 13:35:40 +02:00			`- Configuration: [Provide your own output streams](../examples/231-Cfg-OutputStreams.cpp)`
Update documentation and examples for generators 2019-01-29 10:52:28 +01:00			`- Generators: [Create your own generator](../examples/300-Gen-OwnGenerator.cpp)`
Add another example for generators 2019-02-26 12:46:10 +01:00			`- Generators: [Use map to convert types in GENERATE expression](../examples/301-Gen-MapTypeConversion.cpp)`
Add an example of using GENERATE(table()) There are some examples on issue #850 of using this feature, but they are not easily found from the documentation. Adding them here as an example makes them more findable and ensures they keep working if the API changes. 2020-06-19 16:32:08 +02:00			`- Generators: [Run test with a table of input values](../examples/302-Gen-Table.cpp)`
Update documentation and examples for generators 2019-01-29 10:52:28 +01:00			`- Generators: [Use variables in generator expressions](../examples/310-Gen-VariablesInGenerators.cpp)`
Add GENERATE_COPY and GENERATE_VAR capturing generator macros 2019-03-31 14:11:10 +02:00			`- Generators: [Use custom variable capture in generator expressions](../examples/311-Gen-CustomCapture.cpp)`
Update documentation and examples for generators 2019-01-29 10:52:28 +01:00
Split list of examples into "done" and "planned". Closes #1282 2018-05-09 22:49:04 +02:00
			`## Planned`

Add list of examples to documentation 2017-10-14 10:59:14 +02:00			`- 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)`
Add example for TeamCity reporter and refer to it Prevent warnings - gnu: -Wcomment: multi-line comment - clang: -Wweak-vtables 'class' has no out-of-line virtual method definitions; its vtable will be emitted in every translation unit - clang: -Winconsistent-missing-override: 'method' overrides a member function but is not marked 'override' - MSVC: C4702: unreachable code 2017-11-29 21:22:38 +01:00			`- 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)`
Add list of examples to documentation 2017-10-14 10:59:14 +02:00			`- 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)`