diff options
| author | Leitwolf11 | 2026-09-25 00:54:06 +0300 |
|---|---|---|
| committer | Leitwolf11 | 2026-09-25 00:54:06 +0300 |
| commit | 3ca94ed8f321c6a8e4bbbe9ba316eecd8880537e (patch) | |
| tree | a6f7729e4323c79b489f3a488b90a97c0ac6ecea /docs | |
| parent | c3a325d284ab2487f472f3a8b928c0b12a200979 (diff) | |
| download | catch3-3ca94ed8f321c6a8e4bbbe9ba316eecd8880537e.tar.gz | |
Remove nonexistent Catch3 example links and repair documentation references
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/list-of-examples.md | 26 | ||||
| -rw-r--r-- | docs/migrate-v2-to-v3.md | 4 | ||||
| -rw-r--r-- | docs/release-notes.md | 2 |
3 files changed, 7 insertions, 25 deletions
diff --git a/docs/list-of-examples.md b/docs/list-of-examples.md index bf7c6094..9da305a4 100644 --- a/docs/list-of-examples.md +++ b/docs/list-of-examples.md @@ -15,6 +15,7 @@ - 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) +- Configuration: [Provide your own main](../examples/232-Cfg-CustomMain.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) @@ -22,28 +23,9 @@ - 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) +The checked-in examples above are the maintained examples. Additional assertions, +reporters, and configuration features are documented in the reference pages; +this catalog does not link to source files that do not exist. --- diff --git a/docs/migrate-v2-to-v3.md b/docs/migrate-v2-to-v3.md index c86a52c6..b0ad3fc6 100644 --- a/docs/migrate-v2-to-v3.md +++ b/docs/migrate-v2-to-v3.md @@ -37,8 +37,8 @@ To migrate to v3, there are two basic approaches to do so. 1. Use `catch_amalgamated.hpp` and `catch_amalgamated.cpp`. 2. Build Catch2 as a proper (static) library, and move to piecewise headers -Doing 1 means downloading the [amalgamated header](/extras/catch_amalgamated.hpp) -and the [amalgamated sources](/extras/catch_amalgamated.cpp) from `extras`, +Doing 1 means downloading the [amalgamated header](../extras/catch_amalgamated.hpp) +and the [amalgamated sources](../extras/catch_amalgamated.cpp) from `extras`, dropping them into your test project, and rewriting your includes from `<catch2/catch.hpp>` to `"catch_amalgamated.hpp"` (or something similar, based on how you set up your paths). diff --git a/docs/release-notes.md b/docs/release-notes.md index 23189307..3a2c7734 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -2020,7 +2020,7 @@ Cygwin issue with `gettimeofday` - `#define` was not early enough * _More changes are coming_ * Added [TAP (Test Anything Protocol)](https://testanything.org/) and [Automake](https://www.gnu.org/software/automake/manual/html_node/Log-files-generation-and-test-results-recording.html#Log-files-generation-and-test-results-recording) reporters. * These are not present in the default single-include header and need to be downloaded from GitHub separately. - * For details see [documentation about integrating with build systems](build-systems.md#top). + * For the current fork, see [tooling integration](ci-and-misc.md#top). * XML reporter now reports filename as part of the `Section` and `TestCase` tags. * `Approx` now supports an optional margin of absolute error * It has also received [new documentation](assertions.md#top). |