clarified that Raise() and Lower() only work for wxTopLevelWindows (closes #4717)

[wxWidgets.git] / interface / wx / scopeguard.h

diff --git a/interface/wx/scopeguard.h b/interface/wx/scopeguard.h
index c0a14ec1374194c1041d1cce4435f92226b2d07c..01887eb6039cb97eff96c82828140dd26ed6d0f7 100644 (file)
--- 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.
     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
 {
  */
 class wxScopeGuard
 {


@@ -126,6 +131,9 @@ wxScopeGuard wxMakeGuard(F func, P1 p1, ..., PN pN);
     }
     @endcode
 
     }
     @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}
     @see wxON_BLOCK_EXIT_OBJ0(), wxON_BLOCK_EXIT_NULL()
 
     @header{wx/scopeguard.h}