aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJacob Bachmeyer <jcb@gnu.org>2022-11-29 21:48:48 -0600
committerJacob Bachmeyer <jcb@gnu.org>2022-11-29 21:48:48 -0600
commitb1a37815d0d1a8cbc9f980f20ddafaa29b5e503c (patch)
tree567c3d9333e184add597b0d52a49da523d112407 /doc
parent1757c1eeff6cda9f77591349f190c86fdcdccb7e (diff)
downloaddejagnu-b1a37815d0d1a8cbc9f980f20ddafaa29b5e503c.zip
dejagnu-b1a37815d0d1a8cbc9f980f20ddafaa29b5e503c.tar.gz
dejagnu-b1a37815d0d1a8cbc9f980f20ddafaa29b5e503c.tar.bz2
Fix incorrect documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/dejagnu.texi10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/dejagnu.texi b/doc/dejagnu.texi
index deeb46d..0b6777b 100644
--- a/doc/dejagnu.texi
+++ b/doc/dejagnu.texi
@@ -2656,10 +2656,12 @@ as the message to be displayed. There currently is no support for
formatted output in the C++ API; build the desired string before
passing it to these functions.
-Note that the C API is also available in C++ unit test programs; using
-both will cause confusion because each @code{TestState} object carries
-its own set of summary counters, while the C API has an independent
-global set of summary counters.
+Note that the C API is also available in C++ unit test programs; all
+@code{TestState} objects and the C API share the same global set of
+summary counters. Also note that a single global @code{TestState}
+object should be used, since the constructor clears the summary
+counters and the @code{totals} method is automatically called when a
+@code{TestState} object is destroyed.
The @code{TestState} class supports the following instance methods: