Document wxMessageQueueError.

Document the enum defining the error codes of wxMessageQueue<> class.

Closes #12634.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@65964 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/msgqueue.h b/interface/wx/msgqueue.h
index 3e3cc120dd5ce8f4c87c323550bc6f35f39f47c7..376625a3f068c9275beccb98064b6ff4abef50aa 100644 (file)
--- a/interface/wx/msgqueue.h
+++ b/interface/wx/msgqueue.h
@@ -1,11 +1,35 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        msgqueue.h
+// Name:        wx/msgqueue.h

 // Purpose:     interface of wxMessageQueue<T>
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Purpose:     interface of wxMessageQueue<T>
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

+/**
+    Error codes for wxMessageQueue<> operations.
+
+    This enum contains the possible return value of wxMessageQueue<> methods.
+
+    @since 2.9.0
+    @category{threading}
+ */
+enum wxMessageQueueError
+{
+    /// Indicates that the operation completed successfully.
+    wxMSGQUEUE_NO_ERROR = 0,
+
+    /**
+        Indicates that no messages were received before timeout expired.
+
+        This return value is only used by wxMessageQueue<>::ReceiveTimeout().
+     */
+    wxMSGQUEUE_TIMEOUT,
+
+    /// Some unexpected (and fatal) error has occurred.
+    wxMSGQUEUE_MISC_ERROR
+};
+

 /**
     wxMessageQueue allows passing messages between threads.
 
 /**
     wxMessageQueue allows passing messages between threads.