X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c913512a4c9f36e11e07ea707002fab1608d324..9fb99466b5b43589f477783ca65bf17714ff8615:/interface/msgqueue.h

diff --git a/interface/msgqueue.h b/interface/msgqueue.h
index fa57761674..2b23de8b9a 100644
--- a/interface/msgqueue.h
+++ b/interface/msgqueue.h
@@ -1,13 +1,12 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        msgqueue.h
-// Purpose:     documentation for wxMessageQueue<T> class
+// Purpose:     interface of wxMessageQueue<T>
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 /**
-    @class wxMessageQueueT
     @wxheader{msgqueue.h}
 
     wxMessageQueue allows passing messages between threads.
@@ -24,8 +23,7 @@
     @nolibrary
     @category{FIXME}
 
-    @seealso
-    wxThread
+    @see wxThread
 */
 class wxMessageQueue<T>
 {
@@ -34,13 +32,12 @@ public:
         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).
-        
         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.
-        
         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);
@@ -73,3 +66,4 @@ public:
     */
     wxMessageQueue();
 };
+