Move and rename ThreadData::FreeThread() to ThreadEngine::Stop() and document what it does

1 files changed, 12 insertions, 1 deletions

diff --git a/include/threadengines/threadengine_pthread.h b/include/threadengines/threadengine_pthread.h
index 5756926fd..9304536f1 100644
--- a/include/threadengines/threadengine_pthread.h
+++ b/include/threadengines/threadengine_pthread.h
@@ -43,13 +43,24 @@ class CoreExport ThreadEngine
 	 * derived object.
 	 */
 	void Start(Thread* thread_to_init);
+
+	/** Stop a thread gracefully.
+	 * First, this function asks the thread to terminate by calling Thread::SetExitFlag().
+	 * Next, it waits until the thread terminates (on the operating system level). Finally,
+	 * all OS-level resources associated with the thread are released. The Thread instance
+	 * passed to the function is NOT freed.
+	 * When this function returns, the thread is stopped and you can destroy it or restart it
+	 * at a later point.
+	 * Stopping a thread that is not running is a bug.
+	 * @param thread The thread to stop.
+	 */
+	void Stop(Thread* thread);
 };
 
 class CoreExport ThreadData
 {
  public:
 	pthread_t pthread_id;
-	void FreeThread(Thread* toFree);
 };
 
 /** The Mutex class represents a mutex, which can be used to keep threads