Skip to content

Commit 8430426

Browse files
cbarrickJohnTitor
authored andcommitted
ctest: Update docs for the type rename methods
See #4996
1 parent 1a3ff59 commit 8430426

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

ctest/src/generator.rs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -927,6 +927,10 @@ impl TestGenerator {
927927
///
928928
/// # Examples
929929
///
930+
/// This method can be used to remove the `struct` keyword from types in the
931+
/// generated tests. For example, the code below will generate tests for
932+
/// `timeval_t` rather than `struct timeval`.
933+
///
930934
/// ```no_run
931935
/// use ctest::TestGenerator;
932936
///
@@ -950,6 +954,10 @@ impl TestGenerator {
950954
///
951955
/// # Examples
952956
///
957+
/// This method can be used to remove the `union` keyword from types in the
958+
/// generated tests. For example, the code below will generate tests for
959+
/// `__T1Union` rather than `union T1Union`.
960+
///
953961
/// ```no_run
954962
/// use ctest::TestGenerator;
955963
///

0 commit comments

Comments
 (0)