reverted wxVideoMode API breakage by r53049, finished documentation for it

[wxWidgets.git] / interface / recguard.h

diff --git a/interface/recguard.h b/interface/recguard.h
index 1ced2af672b8fbffd95b29b1a954a21800937cce..89cda8df07261d7bc939f556dfd2629acc6e8870 100644 (file)
--- a/interface/recguard.h
+++ b/interface/recguard.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        recguard.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        recguard.h

-// Purpose:     documentation for wxRecursionGuardFlag class
+// Purpose:     interface of wxRecursionGuardFlag

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -9,36 +9,37 @@
 /**
     @class wxRecursionGuardFlag
     @wxheader{recguard.h}
 /**
     @class wxRecursionGuardFlag
     @wxheader{recguard.h}

-    
-    This is a completely opaque class which exists only to be used with 
+
+    This is a completely opaque class which exists only to be used with

     wxRecursionGuard, please see the example in that
     class documentation.
     wxRecursionGuard, please see the example in that
     class documentation.

-    
-    Please notice that wxRecursionGuardFlag object must be declared 
+
+    Please notice that wxRecursionGuardFlag object must be declared

     @c static or the recursion would never be detected.
     @c static or the recursion would never be detected.

-    
+

     @library{wxbase}
     @category{FIXME}
 */
     @library{wxbase}
     @category{FIXME}
 */

-class wxRecursionGuardFlag 
+class wxRecursionGuardFlag

 {
 public:
 {
 public:

-    
+

 };
 
 
 };
 
 

+

 /**
     @class wxRecursionGuard
     @wxheader{recguard.h}
 /**
     @class wxRecursionGuard
     @wxheader{recguard.h}

-    
+

     wxRecursionGuard is a very simple class which can be used to prevent reentrancy
     problems in a function. It is not thread-safe and so should be used only in
     single-threaded programs or in combination with some thread synchronization
     mechanisms.
     wxRecursionGuard is a very simple class which can be used to prevent reentrancy
     problems in a function. It is not thread-safe and so should be used only in
     single-threaded programs or in combination with some thread synchronization
     mechanisms.

-    
-    wxRecursionGuard is always used together with the 
+
+    wxRecursionGuard is always used together with the

     wxRecursionGuardFlag like in this example:
     wxRecursionGuardFlag like in this example:

-    
+

     @code
     void Foo()
         {
     @code
     void Foo()
         {


@@ -49,29 +50,29 @@ public:
                 // don't allow reentrancy
                 return;
             }
                 // don't allow reentrancy
                 return;
             }

-    
+

             ...
         }
     @endcode
             ...
         }
     @endcode

-    
+

     As you can see, wxRecursionGuard simply tests the flag value and sets it to
     As you can see, wxRecursionGuard simply tests the flag value and sets it to

-    @true if it hadn't been already set. 
+    @true if it hadn't been already set.

     wxRecursionGuard::IsInside allows testing the old flag
     value. The advantage of using this class compared to directly manipulating the
     flag is that the flag is always reset in the wxRecursionGuard destructor and so
     you don't risk to forget to do it even if the function returns in an unexpected
     way (for example because an exception has been thrown).
     wxRecursionGuard::IsInside allows testing the old flag
     value. The advantage of using this class compared to directly manipulating the
     flag is that the flag is always reset in the wxRecursionGuard destructor and so
     you don't risk to forget to do it even if the function returns in an unexpected
     way (for example because an exception has been thrown).

-    
+

     @library{wxbase}
     @category{FIXME}
 */
     @library{wxbase}
     @category{FIXME}
 */

-class wxRecursionGuard 
+class wxRecursionGuard

 {
 public:
     /**
 {
 public:
     /**

-        A wxRecursionGuard object must always be initialized with a (static) 
+        A wxRecursionGuard object must always be initialized with a (static)

         wxRecursionGuardFlag. The constructor saves the
         wxRecursionGuardFlag. The constructor saves the

-        value of the flag to be able to return the correct value from 
+        value of the flag to be able to return the correct value from

         IsInside().
     */
     wxRecursionGuard(wxRecursionGuardFlag& flag);
         IsInside().
     */
     wxRecursionGuard(wxRecursionGuardFlag& flag);


@@ -79,19 +80,18 @@ public:
     /**
         The destructor resets the flag value so that the function can be entered again
         the next time.
     /**
         The destructor resets the flag value so that the function can be entered again
         the next time.

-        

         Note that it is not virtual and so this class is not meant to be derived from
         (besides, there is absolutely no reason to do it anyhow).
     */
     ~wxRecursionGuard();
 
     /**
         Note that it is not virtual and so this class is not meant to be derived from
         (besides, there is absolutely no reason to do it anyhow).
     */
     ~wxRecursionGuard();
 
     /**

-        Returns @true if we're already inside the code block "protected'' by this
+        Returns @true if we're already inside the code block "protected" by this

         wxRecursionGuard (i.e. between this line and the end of current scope). Usually
         the function using wxRecursionGuard takes some specific actions in such case
         (may be simply returning) to prevent reentrant calls to itself.
         wxRecursionGuard (i.e. between this line and the end of current scope). Usually
         the function using wxRecursionGuard takes some specific actions in such case
         (may be simply returning) to prevent reentrant calls to itself.

-        

         If this method returns @false, it is safe to continue.
     */
         If this method returns @false, it is safe to continue.
     */

-    bool IsInside();
+    bool IsInside() const;

 };
 };

+