From a0988dabf62137d972236dcd2c5771152d7bbf11 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Ho=C5=99e=C5=88ovsk=C3=BD?= Date: Sun, 27 Aug 2017 16:47:25 +0200 Subject: [PATCH] Add the experimental benchmark feature in documentation --- docs/test-cases-and-sections.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/test-cases-and-sections.md b/docs/test-cases-and-sections.md index 56600759..0e5cc466 100644 --- a/docs/test-cases-and-sections.md +++ b/docs/test-cases-and-sections.md @@ -49,6 +49,8 @@ All tag names beginning with non-alphanumeric characters are reserved by Catch. * `[@]` - tag aliases all begin with `@` (see below). +* `[!benchmark]` - this test case is actually a benchmark. This is an experimental feature, and currently has no documentation. If you want to try it out, look at `projects/SelfTest/Benchmark.tests.cpp` for details. + ## Tag aliases Between tag expressions and wildcarded test names (as well as combinations of the two) quite complex patterns can be constructed to direct which test cases are run. If a complex pattern is used often it is convenient to be able to create an alias for the expression. this can be done, in code, using the following form: