removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -34,13 +34,12 @@ public:
|
||||
Returns @true if the object had been initialized successfully, @false
|
||||
if an error occurred.
|
||||
*/
|
||||
#define bool IsOk() /* implementation is private */
|
||||
bool IsOk();
|
||||
|
||||
/**
|
||||
Add a message to this queue and signal the threads waiting for messages
|
||||
(i.e. the threads which called wxMessageQueue::Receive or
|
||||
wxMessageQueue::ReceiveTimeout).
|
||||
|
||||
This method is safe to call from multiple threads in parallel.
|
||||
*/
|
||||
wxMessageQueueError Post(T const& msg);
|
||||
@@ -48,21 +47,17 @@ public:
|
||||
/**
|
||||
Block until a message becomes available in the queue. Waits indefinitely long
|
||||
or until an error occurs.
|
||||
|
||||
The message is returned in @e msg.
|
||||
*/
|
||||
wxMessageQueueError Receive(T& msg);
|
||||
|
||||
/**
|
||||
Block until a message becomes available in the queue, but no more than
|
||||
@e timeout milliseconds has elapsed.
|
||||
|
||||
If no message is available after @e timeout milliseconds then returns
|
||||
@a timeout milliseconds has elapsed.
|
||||
If no message is available after @a timeout milliseconds then returns
|
||||
@b wxMSGQUEUE_TIMEOUT.
|
||||
|
||||
If @e timeout is 0 then checks for any messages present in the queue
|
||||
If @a timeout is 0 then checks for any messages present in the queue
|
||||
and returns immediately without waiting.
|
||||
|
||||
The message is returned in @e msg.
|
||||
*/
|
||||
wxMessageQueueError ReceiveTimeout(long timeout, T& msg);
|
||||
|
Reference in New Issue
Block a user