execute the usual cleanup code from EVT_END_SESSION handler under MSW, otherwise...

[wxWidgets.git] / interface / msgqueue.h

diff --git a/interface/msgqueue.h b/interface/msgqueue.h
index fa577616743fcbf363568899f30c8847d08988de..2b23de8b9a4d87eb0dd5aa23fb829f10b7ed8a33 100644 (file)
--- a/interface/msgqueue.h
+++ b/interface/msgqueue.h
@@ -1,13 +1,12 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        msgqueue.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        msgqueue.h

-// Purpose:     documentation for wxMessageQueue<T> class
+// Purpose:     interface of wxMessageQueue<T>

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

-    @class wxMessageQueueT

     @wxheader{msgqueue.h}
 
     wxMessageQueue allows passing messages between threads.
     @wxheader{msgqueue.h}
 
     wxMessageQueue allows passing messages between threads.


@@ -24,8 +23,7 @@
     @nolibrary
     @category{FIXME}
 
     @nolibrary
     @category{FIXME}
 

-    @seealso
-    wxThread
+    @see wxThread

 */
 class wxMessageQueue<T>
 {
 */
 class wxMessageQueue<T>
 {


@@ -34,13 +32,12 @@ public:
         Returns @true if the object had been initialized successfully, @false
         if an error occurred.
     */
         Returns @true if the object had been initialized successfully, @false
         if an error occurred.
     */

-#define bool IsOk()     /* implementation is private */
+    bool IsOk() const;

 
     /**
         Add a message to this queue and signal the threads waiting for messages
         (i.e. the threads which called wxMessageQueue::Receive or
         wxMessageQueue::ReceiveTimeout).
 
     /**
         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);
         This method is safe to call from multiple threads in parallel.
     */
     wxMessageQueueError Post(T const& msg);


@@ -48,21 +45,17 @@ public:
     /**
         Block until a message becomes available in the queue. Waits indefinitely long
         or until an error occurs.
     /**
         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
         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.
         @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.
         and returns immediately without waiting.

-        

         The message is returned in @e msg.
     */
     wxMessageQueueError ReceiveTimeout(long timeout, T& msg);
         The message is returned in @e msg.
     */
     wxMessageQueueError ReceiveTimeout(long timeout, T& msg);


@@ -73,3 +66,4 @@ public:
     */
     wxMessageQueue();
 };
     */
     wxMessageQueue();
 };

+