X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/bcffb4d1a9edaa539770382e14129ac902da68d8..2b4367d520dc794b30e947e46888c30fb85b044b:/interface/wx/scopeguard.h diff --git a/interface/wx/scopeguard.h b/interface/wx/scopeguard.h index c0a14ec137..01887eb603 100644 --- a/interface/wx/scopeguard.h +++ b/interface/wx/scopeguard.h @@ -7,9 +7,14 @@ ///////////////////////////////////////////////////////////////////////////// /** + @class wxScopeGuard + Scope guard is an object which allows executing an action on scope exit. The objects of this class must be constructed using wxMakeGuard() function. + + @nolibrary + @category{misc} */ class wxScopeGuard { @@ -126,6 +131,9 @@ wxScopeGuard wxMakeGuard(F func, P1 p1, ..., PN pN); } @endcode + Notice that @a value is copied, i.e. stored by value, so it can be a + temporary object returned by a function call, for example. + @see wxON_BLOCK_EXIT_OBJ0(), wxON_BLOCK_EXIT_NULL() @header{wx/scopeguard.h}