Document wxAppConsole::Yield() and fix wxYield() documentation
Don't say that wxYield() is deprecated because it isn't. Do document wxAppConsole::Yield() if only to redirect to wxEvtLoopBase::Yield().
This commit is contained in:
@@ -222,6 +222,18 @@ public:
|
|||||||
//@}
|
//@}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
Yields control to pending messages in the event loop.
|
||||||
|
|
||||||
|
This method is a convenient wrapper for wxEvtLoopBase::Yield(). If the
|
||||||
|
main loop is currently running, it calls this method on it. Otherwise
|
||||||
|
it creates a temporary event loop and uses it instead, which can be
|
||||||
|
useful to process pending messages during the program startup, before
|
||||||
|
the main loop is created.
|
||||||
|
|
||||||
|
Use extreme caution when calling this function as, just as
|
||||||
|
wxEvtLoopBase::Yield(), it can result in unexpected reentrances.
|
||||||
|
*/
|
||||||
bool Yield(bool onlyIfNeeded = false);
|
bool Yield(bool onlyIfNeeded = false);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -1193,11 +1205,12 @@ void wxUninitialize();
|
|||||||
void wxWakeUpIdle();
|
void wxWakeUpIdle();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Calls wxAppConsole::Yield.
|
Calls wxAppConsole::Yield if there is an existing application object.
|
||||||
|
|
||||||
@deprecated
|
Does nothing if there is no application (which typically only happens early
|
||||||
This function is kept only for backwards compatibility. Please use
|
during the program startup or late during its shutdown).
|
||||||
the wxAppConsole::Yield method instead in any new code.
|
|
||||||
|
@see wxEvtLoopBase::Yield()
|
||||||
|
|
||||||
@header{wx/app.h}
|
@header{wx/app.h}
|
||||||
*/
|
*/
|
||||||
|
Reference in New Issue
Block a user