X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7d9550df507d5522ac76887e5876b314b729ed50..1b7751aaa9a86d76a850b9267bc0c201e3cea30f:/interface/wx/debug.h diff --git a/interface/wx/debug.h b/interface/wx/debug.h index ac3164e262..7e787e88c4 100644 --- a/interface/wx/debug.h +++ b/interface/wx/debug.h @@ -3,12 +3,23 @@ // Purpose: interface of global functions // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @addtogroup group_funcmacro_debug */ //@{ +/** + Exits the program immediately. + + This is a simple wrapper for the standard abort() function which is not + available under all platforms (currently only Windows CE doesn't provide + it). + + @since 2.9.4 + */ +void wxAbort(); + /** @def wxDEBUG_LEVEL @@ -249,10 +260,10 @@ void wxDisableAsserts(); @def wxDISABLE_ASSERTS_IN_RELEASE_BUILD Use this macro to disable asserts in release build when not using - IMPLEMENT_APP(). + wxIMPLEMENT_APP(). By default, assert message boxes are suppressed in release build by - IMPLEMENT_APP() which uses this macro. If you don't use IMPLEMENT_APP() + wxIMPLEMENT_APP() which uses this macro. If you don't use wxIMPLEMENT_APP() because your application initializes wxWidgets directly (e.g. calls wxEntry() or wxEntryStart() itself) but still want to suppress assert notifications in release build you need to use this macro directly. @@ -289,7 +300,7 @@ void wxDisableAsserts(); Will always generate an assert error with specified message if this code is reached (in debug mode). - This macro is useful for marking unreachable" code areas, for example it + This macro is useful for marking "unreachable" code areas, for example it may be used in the "default:" branch of a switch statement if all possible cases are processed above. @@ -306,7 +317,7 @@ void wxDisableAsserts(); Returns @true if the program is running under debugger, @false otherwise. Please note that this function is currently only implemented for Win32 and - Mac builds using CodeWarrior and always returns @false elsewhere. + always returns @false elsewhere. @header{wx/debug.h} */ @@ -363,10 +374,13 @@ wxAssertHandler_t wxSetAssertHandler(wxAssertHandler_t handler); void wxSetDefaultAssertHandler(); /** - In debug mode (when @c __WXDEBUG__ is defined) this function generates a - debugger exception meaning that the control is passed to the debugger if - one is attached to the process. Otherwise the program just terminates - abnormally. In release mode this function does nothing. + Generate a debugger exception meaning that the control is passed to the + debugger if one is attached to the process. + + Otherwise the program just terminates abnormally. + + If @c wxDEBUG_LEVEL is 0 (which is not the default) this function does + nothing. @header{wx/debug.h} */