[trac542] Additional documentation on use of run_all()

1 files changed, 7 insertions, 2 deletions

diff --git a/src/lib/util/unittests/run_all.h b/src/lib/util/unittests/run_all.h
index 59abe3eb45..48fd6faa2e 100644
--- a/src/lib/util/unittests/run_all.h
+++ b/src/lib/util/unittests/run_all.h
@@ -29,10 +29,15 @@ namespace unittests {
 ///
 /// A wrapper for the Google Test RUN_ALL_TESTS() macro, this calls the macro
 /// but wraps the call in a try...catch block if the environment variable
-/// B10TEST_CATCH_EXCEPTION is defined.  In the latter case, the class and
-/// type of the exception is printed.
+/// B10TEST_CATCH_EXCEPTION is defined, and calls the macro directly if not.
+///
+/// The catch block catches exceptions of types isc::Exception and
+/// std::Exception and prints some information about them to stderr. (In the
+/// case of isc::Exception, this includes the file and line number from which
+/// the exception was raised.)  It then re-throws the exception.
 ///
 /// See: https://lists.isc.org/pipermail/bind10-dev/2011-January/001867.html
+/// for some context.
 ///
 /// \return Return value from RUN_ALL_TESTS().