diff --git a/docs/generators.md b/docs/generators.md index eb1a255a..85acf2b5 100644 --- a/docs/generators.md +++ b/docs/generators.md @@ -21,7 +21,10 @@ The "Generators" `TEST_CASE` will be entered 3 times, and the value of `i` will be 1, 3, and 5 in turn. `GENERATE`s can also be used multiple times at the same scope, in which case the result will be a cartesian product of all elements in the generators. This means that in the snippet -below, the test case will be run 6 (2\*3) times. +below, the test case will be run 6 (2\*3) times. The `GENERATE` +is defined in the `catch_generators.hpp` header, so compiling +the code examples below also requires +`#include `. ```cpp TEST_CASE("Generators") { @@ -103,7 +106,7 @@ a test case, * 2 fundamental generators * `SingleValueGenerator` -- contains only single element * `FixedValuesGenerator` -- contains multiple elements -* 5 generic generators that modify other generators +* 5 generic generators that modify other generators (defined in `catch2/generators/catch_generators_adapters.hpp`) * `FilterGenerator` -- filters out elements from a generator for which the predicate returns "false" * `TakeGenerator` -- takes first `n` elements from a generator @@ -111,11 +114,11 @@ a test case, * `MapGenerator` -- returns the result of applying `Func` on elements from a different generator * `ChunkGenerator` -- returns chunks (inside `std::vector`) of n elements from a generator -* 4 specific purpose generators +* 4 specific purpose generators (defined in `catch2/generators/catch_generators_random.hpp`) * `RandomIntegerGenerator` -- generates random Integrals from range * `RandomFloatGenerator` -- generates random Floats from range - * `RangeGenerator(first, last)` -- generates all values inside a `[first, last)` arithmetic range - * `IteratorGenerator` -- copies and returns values from an iterator range + * `RangeGenerator(first, last)` -- generates all values inside a `[first, last)` arithmetic range (defined in `catch2/generators/catch_generators_range.hpp`) + * `IteratorGenerator` -- copies and returns values from an iterator range (defined in `catch2/generators/catch_generators_range.hpp`) > `ChunkGenerator`, `RandomIntegerGenerator`, `RandomFloatGenerator` and `RangeGenerator` were introduced in Catch2 2.7.0.