diff options
author | Copybara-Service <copybara-worker@google.com> | 2022-10-17 21:08:04 (GMT) |
---|---|---|
committer | Copybara-Service <copybara-worker@google.com> | 2022-10-17 21:08:04 (GMT) |
commit | 6d71d901e1a5dc3460cdcdce091e4e99e68940dd (patch) | |
tree | 6b8777e61666f4e2bbd316fe0aff1951a942dd0a /docs | |
parent | 88c59752c05d74475c3d487b28c5e82ad0b129b8 (diff) | |
parent | a41c3d0fb80c4558aa3799f262a7cfd67f32c468 (diff) | |
download | googletest-6d71d901e1a5dc3460cdcdce091e4e99e68940dd.zip googletest-6d71d901e1a5dc3460cdcdce091e4e99e68940dd.tar.gz googletest-6d71d901e1a5dc3460cdcdce091e4e99e68940dd.tar.bz2 |
Merge pull request #4037 from KloolK:patch-1
PiperOrigin-RevId: 481734961
Change-Id: I629dc1ca3b10bf5fc6afc179b651a09081f5c919
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/testing.md | 25 |
1 files changed, 8 insertions, 17 deletions
diff --git a/docs/reference/testing.md b/docs/reference/testing.md index dd0b982..62cdcc1 100644 --- a/docs/reference/testing.md +++ b/docs/reference/testing.md @@ -102,23 +102,14 @@ namespace: <span id="param-generators"></span> -| Parameter Generator | Behavior | -| ---------------------------- | -------------------------------------------- | -| `Range(begin, end [, step])` | Yields values `{begin, begin+step, | -: : begin+step+step, ...}`. The values do not : -: : include `end`. `step` defaults to 1. : -| `Values(v1, v2, ..., vN)` | Yields values `{v1, v2, ..., vN}`. | -| `ValuesIn(container)` or | Yields values from a C-style array, an | -: `ValuesIn(begin,end)` : STL-style container, or an iterator range : -: : `[begin, end)`. : -| `Bool()` | Yields sequence `{false, true}`. | -| `Combine(g1, g2, ..., gN)` | Yields as `std::tuple` *n*-tuples all | -: : combinations (Cartesian product) of the : -: : values generated by the given *n* generators : -: : `g1`, `g2`, ..., `gN`. : -| `ConvertGenerator<T>(g)` | Yields values generated by generator `g`, | -: : `static_cast` to `T`. : - +| Parameter Generator | Behavior | +| ------------------- | ---------------------------------------------------- | +| `Range(begin, end [, step])` | Yields values `{begin, begin+step, begin+step+step, ...}`. The values do not include `end`. `step` defaults to 1. | +| `Values(v1, v2, ..., vN)` | Yields values `{v1, v2, ..., vN}`. | +| `ValuesIn(container)` or `ValuesIn(begin,end)` | Yields values from a C-style array, an STL-style container, or an iterator range `[begin, end)`. | +| `Bool()` | Yields sequence `{false, true}`. | +| `Combine(g1, g2, ..., gN)` | Yields as `std::tuple` *n*-tuples all combinations (Cartesian product) of the values generated by the given *n* generators `g1`, `g2`, ..., `gN`. | +| `ConvertGenerator<T>(g)` | Yields values generated by generator `g`, `static_cast` to `T`. | The optional last argument *`name_generator`* is a function or functor that generates custom test name suffixes based on the test parameters. The function must accept an argument of type |