reorder the classes, putting first the basic ones and towards the end of the file...

[wxWidgets.git] / interface / wx / thread.h

diff --git a/interface/wx/thread.h b/interface/wx/thread.h
index c454f8e92513ed178d48d7d556a29be43b5b3d8f..0985caf1b6f591ebbe045a8a9a5a32419ba3ffd6 100644 (file)
--- a/interface/wx/thread.h
+++ b/interface/wx/thread.h
@@ -454,6 +454,12 @@ public:
     */
     virtual ExitCode Entry() = 0;
 
+    /**
+        @deprecated
+        Use CreateThread() instead.
+    */
+    wxThreadError Create(unsigned int stackSize = 0);
+
     /**
         Creates a new thread of the given @a kind.
 
@@ -966,6 +972,10 @@ public:
     /**
         Returns the number of system CPUs or -1 if the value is unknown.
 
+        For multi-core systems the returned value is typically the total number
+        of @e cores, since the OS usually abstract a single N-core CPU
+        as N different cores.
+
         @see SetConcurrency()
     */
     static int GetCPUCount();
@@ -974,7 +984,7 @@ public:
         Returns the platform specific thread ID of the current thread as a long.
         This can be used to uniquely identify threads, even if they are not wxThreads.
     */
-    static unsigned long GetCurrentId();
+    static wxThreadIdType GetCurrentId();
 
     /**
         Gets the thread identifier: this is a platform dependent number that uniquely
@@ -1058,17 +1068,6 @@ public:
     */
     wxThreadError Kill();
 
-    /**
-        Called when the thread exits.
-
-        This function is called in the context of the thread associated with the
-        wxThread object, not in the context of the main thread.
-        This function will not be called if the thread was @ref Kill() killed.
-
-        This function should never be called directly.
-    */
-    virtual void OnExit();
-
     /**
         Suspends the thread.
 
@@ -1227,6 +1226,19 @@ protected:
         OnExit() will be called just before exiting.
     */
     void Exit(ExitCode exitcode = 0);
+
+private:
+
+    /**
+        Called when the thread exits.
+
+        This function is called in the context of the thread associated with the
+        wxThread object, not in the context of the main thread.
+        This function will not be called if the thread was @ref Kill() killed.
+
+        This function should never be called directly.
+    */
+    virtual void OnExit();
 };
 
 
@@ -1525,7 +1537,7 @@ public:
 // Global functions/macros
 // ============================================================================
 
-/** @ingroup group_funcmacro_thread */
+/** @addtogroup group_funcmacro_thread */
 //@{
 
 /**
@@ -1626,7 +1638,7 @@ bool wxIsMainThread();
         wxMutexGuiEnter();
 
         // Call GUI here:
-        my_window-DrawSomething();
+        my_window->DrawSomething();
 
         wxMutexGuiLeave();
     }