Style and comment updates

[libs/core.git] / source / core / thread.h

diff --git a/source/core/thread.h b/source/core/thread.h
index ac7169ff0250c509260f7303834d34fb7fb83155..ae257078569c47844e0d4502886f5de403371885 100644 (file)
--- a/source/core/thread.h
+++ b/source/core/thread.h
@@ -26,7 +26,12 @@ private:
 public:
        virtual ~Thread();
 
+       /** Waits for the thread to exit.  Calling this from the thread will cause a
+       deadlock. */
        void join();
+
+       /** Violently terminates the thread.  This should only be used as a last
+       resort, as the thread gets no chance to clean up. */
        void kill();
 protected:
        void launch();