Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorMartin Hořeňovský2020-03-01 19:59:18 +0100
committerMartin Hořeňovský2020-03-27 10:22:25 +0100
commitc2daf468bb17d4e269183e895f14c6f9ff50b09d (patch)
tree6a2c2b3c08a6e7c754f63a398ed051bdbd337b07 /docs
parent64d7f9b98a04da12a9bba8c10b4e32148bba7fe2 (diff)
downloadcatch3-c2daf468bb17d4e269183e895f14c6f9ff50b09d.tar.gz
Standardize matcher headers to use .hpp suffix
Diffstat (limited to 'docs')
-rw-r--r--docs/matchers.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/matchers.md b/docs/matchers.md
index 26da2679..dbeb1cfc 100644
--- a/docs/matchers.md
+++ b/docs/matchers.md
@@ -47,8 +47,8 @@ _both_ ends with the suffix "as a service" _and_ contains the string
Both of the string matchers used in the examples above live in the
-`catch_matchers_string.h` header, so to compile the code above also
-requires `#include <catch2/matchers/catch_matchers_string.h>`.
+`catch_matchers_string.hpp` header, so to compile the code above also
+requires `#include <catch2/matchers/catch_matchers_string.hpp>`.
**IMPORTANT**: The combining operators do not take ownership of the
matcher objects being combined. This means that if you store combined
@@ -108,7 +108,7 @@ the regex `"abc"` will not match input string `"abcd"`. To match
The second argument sets whether the matching should be case-sensitive
or not. By default, it is case-sensitive.
-> `std::string` matchers live in `catch2/matchers/catch_matchers_string.h`
+> `std::string` matchers live in `catch2/matchers/catch_matchers_string.hpp`
### Vector matchers
@@ -136,7 +136,7 @@ An example usage:
This assertions will pass, because the elements given to the matchers
are a permutation of the ones in `some_vec`.
-> vector matchers live in `catch2/matchers/catch_matchers_vector.h`
+> vector matchers live in `catch2/matchers/catch_matchers_vector.hpp`
### Floating point matchers
@@ -187,7 +187,7 @@ to zero, we would write this assertion:
```
-> floating point matchers live in `catch2/matchers/catch_matchers_floating.h`
+> floating point matchers live in `catch2/matchers/catch_matchers_floating.hpp`
### Miscellaneous matchers
@@ -223,7 +223,7 @@ Catch2 provides an utility macro for asserting that an expression
throws exception of specific type, and that the exception has desired
properties. The macro is `REQUIRE_THROWS_MATCHES(expr, ExceptionType, Matcher)`.
-> `REQUIRE_THROWS_MATCHES` macro lives in `catch2/matchers/catch_matchers.h`
+> `REQUIRE_THROWS_MATCHES` macro lives in `catch2/matchers/catch_matchers.hpp`
Catch2 currently provides only one matcher for exceptions,
@@ -311,7 +311,7 @@ written using the new style, combining old style matchers should
generally compile faster. Also note that you can combine old and new
style matchers arbitrarily.
-> `MatcherBase` lives in `catch2/matchers/catch_matchers.h`
+> `MatcherBase` lives in `catch2/matchers/catch_matchers.hpp`
## Writing custom matchers (new style)