Cleaned up/Fixed wxGrid{Cell,RowOrCol}AttrData::SetAttr, adding some comments.

[wxWidgets.git] / interface / msgqueue.h

diff --git a/interface/msgqueue.h b/interface/msgqueue.h
index 43d076c8285c819731cb9719c7194dd151a4c1b1..2b23de8b9a4d87eb0dd5aa23fb829f10b7ed8a33 100644 (file)
--- a/interface/msgqueue.h
+++ b/interface/msgqueue.h
@@ -1,75 +1,69 @@
 /////////////////////////////////////////////////////////////////////////////
 // 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}
     @wxheader{msgqueue.h}

-    
-    wxMessageQueue allows passing messages between threads.\r
-    
-    This class should be typically used to communicate between the main and worker\r
-    threads. The main thread calls wxMessageQueue::Post and\r
-    the worker thread calls wxMessageQueue::Receive.\r
-    
-    For this class a message is an object of arbitrary type T. Notice that\r
-    often there is a some special message indicating that the thread\r
-    should terminate as there is no other way to gracefully shutdown a thread\r
-    waiting on the message queue.\r
-    
+
+    wxMessageQueue allows passing messages between threads.
+
+    This class should be typically used to communicate between the main and worker
+    threads. The main thread calls wxMessageQueue::Post and
+    the worker thread calls wxMessageQueue::Receive.
+
+    For this class a message is an object of arbitrary type T. Notice that
+    often there is a some special message indicating that the thread
+    should terminate as there is no other way to gracefully shutdown a thread
+    waiting on the message queue.
+

     @nolibrary
     @category{FIXME}
     @nolibrary
     @category{FIXME}

-    
-    @seealso
-    wxThread
+
+    @see wxThread

 */
 */

-class wxMessageQueue<T> 
+class wxMessageQueue<T>

 {
 public:
     /**
 {
 public:
     /**

-        Returns @true if the object had been initialized successfully, @false \r
+        Returns @true if the object had been initialized successfully, @false

         if an error occurred.
     */
         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\r
-        (i.e. the threads which called wxMessageQueue::Receive or\r
-        wxMessageQueue::ReceiveTimeout).\r
-        
+        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);
 
     /**

-        Block until a message becomes available in the queue. Waits indefinitely long\r
-        or until an error occurs.\r
-        
+        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);
 
     /**
         The message is returned in @e msg.
     */
     wxMessageQueueError Receive(T& msg);
 
     /**

-        Block until a message becomes available in the queue, but no more than\r
-        @e timeout milliseconds has elapsed.\r
-        
-        If no message is available after @e timeout milliseconds then returns\r
-        @b wxMSGQUEUE_TIMEOUT.\r
-        
-        If @e timeout is 0 then checks for any messages present in the queue\r
-        and returns immediately without waiting.\r
-        
+        Block until a message becomes available in the queue, but no more than
+        @a timeout milliseconds has elapsed.
+        If no message is available after @a timeout milliseconds then returns
+        @b wxMSGQUEUE_TIMEOUT.
+        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);
 
     /**
         The message is returned in @e msg.
     */
     wxMessageQueueError ReceiveTimeout(long timeout, T& msg);
 
     /**

-        Default and only constructor. Use wxMessageQueue::IsOk to check\r
+        Default and only constructor. Use wxMessageQueue::IsOk to check

         if the object was successfully initialized.
     */
         if the object was successfully initialized.
     */

-     wxMessageQueue();
+    wxMessageQueue();

 };
 };

+