diff options
| author | Jacob Bachmeyer <jcb@gnu.org> | 2022-11-30 22:00:30 -0600 |
|---|---|---|
| committer | Jacob Bachmeyer <jcb@gnu.org> | 2022-11-30 22:00:30 -0600 |
| commit | ee140a3ddf394c840807a01f32d80bfd01d95e03 (patch) | |
| tree | 658ff4dd8b927543eb75b8b37124e07d179b05d0 /doc | |
| parent | 5b0b2df48b0d84086c0050628e95bd93eca94a38 (diff) | |
| download | dejagnu-ee140a3ddf394c840807a01f32d80bfd01d95e03.zip dejagnu-ee140a3ddf394c840807a01f32d80bfd01d95e03.tar.gz dejagnu-ee140a3ddf394c840807a01f32d80bfd01d95e03.tar.bz2 | |
Document use of "DG_" and "DG__" prefixes in dejagnu.h
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/dejagnu.texi | 26 |
1 files changed, 17 insertions, 9 deletions
diff --git a/doc/dejagnu.texi b/doc/dejagnu.texi index 03f7aa9..c162646 100644 --- a/doc/dejagnu.texi +++ b/doc/dejagnu.texi @@ -2554,11 +2554,14 @@ recognized and interpreted by DejaGnu, appears in the log. @cindex C unit testing API The C API is provided in the @file{dejagnu.h} header file. This -header provides a self-contained implementation. For convenience, the -@code{totals()} function can be called at the end of the unit test -program to output summary totals. DejaGnu counts the test results -independently and will operate correctly even if @code{totals()} is -never invoked. +header provides a self-contained implementation and reserves names +prefixed with @code{DG_} for future extensions and names prefixed with +@code{DG__} (two underscores) for internal use. + +For convenience, the @code{totals()} function can be called at the end +of the unit test program to output summary totals. DejaGnu counts the +test results independently and will operate correctly even if +@code{totals()} is never invoked. All of the functions that take a @code{msg} parameter use a C @code{char *} that is the message to be displayed. All of the @@ -2646,10 +2649,15 @@ independently. @cindex C++ unit testing API The C++ API is also provided in the @file{dejagnu.h} header file. -This header provides a self-contained implementation. For -convenience, the @code{totals()} method outputs summary totals to be -used at the end of unit test program. DejaGnu does not depend on this -summary and counts the test results independently. +This header provides a self-contained implementation and reserves +names prefixed with @code{DG_} for future extensions and names +prefixed with @code{DG__} (two underscores) for internal use. In C++, +@file{dejagnu.h} also reserves the C++ namespace @code{DejaGnu} for +possible future use. + +For convenience, the @code{totals()} method outputs summary totals to +be used at the end of unit test program. DejaGnu does not depend on +this summary and counts the test results independently. All of the methods that take a @code{msg} parameter use a STL string as the message to be displayed. There currently is no support for |