diff options
Diffstat (limited to 'boost/test/prg_exec_monitor.hpp')
| -rw-r--r-- | boost/test/prg_exec_monitor.hpp | 35 |
1 files changed, 24 insertions, 11 deletions
diff --git a/boost/test/prg_exec_monitor.hpp b/boost/test/prg_exec_monitor.hpp index 6d65f20776..7234833f72 100644 --- a/boost/test/prg_exec_monitor.hpp +++ b/boost/test/prg_exec_monitor.hpp @@ -1,15 +1,20 @@ -// (C) Copyright Gennadiy Rozental 2001-2008. +// (C) Copyright Gennadiy Rozental 2001-2014. // Distributed under the Boost Software License, Version 1.0. -// (See accompanying file LICENSE_1_0.txt or copy at +// (See accompanying file LICENSE_1_0.txt or copy at // http://www.boost.org/LICENSE_1_0.txt) // See http://www.boost.org/libs/test for the library home page. // -// File : $RCSfile$ -// -// Version : $Revision$ -// -// Description : Entry point for the end user into the Program Execution Monitor. +/// @file +/// @brief Entry point for the end user into the Program Execution Monitor. +/// +/// Use this header to forward declare function prg_exec_monitor_main and to automatically define a main +/// function for you. If you prefer to use your own main you are free to do so, but you need to define +/// BOOST_TEST_NO_MAIN before incuding this header. To initiate your main program body execution you +/// would use statement like this: +/// @code ::boost::prg_exec_monitor_main( &my_main, argc, argv ); @endcode +/// Also this header facilitate auto linking with the Program Execution Monitor library if this feature +/// is supported // *************************************************************************** #ifndef BOOST_PRG_EXEC_MONITOR_HPP_071894GER @@ -23,7 +28,7 @@ // ************** Auto Linking ************** // // ************************************************************************** // -// Automatically link to the correct build variant where possible. +// Automatically link to the correct build variant where possible. #if !defined(BOOST_ALL_NO_LIB) && !defined(BOOST_TEST_NO_LIB) && \ !defined(BOOST_TEST_SOURCE) && !defined(BOOST_TEST_INCLUDED) # define BOOST_LIB_NAME boost_prg_exec_monitor @@ -41,11 +46,18 @@ // ************** prg_exec_monitor_main ************** // // ************************************************************************** // -namespace boost { +namespace boost { +/// @brief Wrapper around the main function +/// +/// Call this routine instead of your own main body implementation directly. This routine impements all the monitoring +/// functionality. THe monitor behavior is configurable by using the environment variable BOOST_TEST_CATCH_SYSTEM_ERRORS. +/// If set to string value "no", the monitor will not attempt to catch system errors (signals) +/// @param[in] cpp_main main function body. Should have the same signature as regular main function +/// @param[in] argc, argv command line arguments int BOOST_TEST_DECL prg_exec_monitor_main( int (*cpp_main)( int argc, char* argv[] ), int argc, char* argv[] ); -} +} // boost #if defined(BOOST_TEST_DYN_LINK) && !defined(BOOST_TEST_NO_MAIN) @@ -53,7 +65,8 @@ int BOOST_TEST_DECL prg_exec_monitor_main( int (*cpp_main)( int argc, char* argv // ************** main function for tests using dll ************** // // ************************************************************************** // -int cpp_main( int argc, char* argv[] ); // prototype for user's cpp_main() +// prototype for user's cpp_main() +int cpp_main( int argc, char* argv[] ); int BOOST_TEST_CALL_DECL main( int argc, char* argv[] ) |