adjusted indentation with astyle; added Id keyword

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52383 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-08 14:43:31 +00:00
parent aa6ec1d787
commit 7c913512a4
269 changed files with 9052 additions and 9058 deletions

View File

@@ -9,36 +9,36 @@
/**
@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.
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.
@library{wxbase}
@category{FIXME}
*/
class wxRecursionGuardFlag
class wxRecursionGuardFlag
{
public:
};
/**
@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 always used together with the
wxRecursionGuard is always used together with the
wxRecursionGuardFlag like in this example:
@code
void Foo()
{
@@ -49,29 +49,29 @@ public:
// don't allow reentrancy
return;
}
...
}
@endcode
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).
@library{wxbase}
@category{FIXME}
*/
class wxRecursionGuard
class wxRecursionGuard
{
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
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);