Add more doxygen comments for llvm::ThreadLocal.

[oota-llvm.git] / include / llvm / System / ThreadLocal.h

diff --git a/include/llvm/System/ThreadLocal.h b/include/llvm/System/ThreadLocal.h
index 7627be26d2e7313aa3458f7e9a5cb105dce75571..3d44f62e959323051a94fa418ded88ae2362ce91 100644 (file)
--- a/include/llvm/System/ThreadLocal.h
+++ b/include/llvm/System/ThreadLocal.h
@@ -19,20 +19,29 @@
 
 namespace llvm {
   namespace sys {
+    // ThreadLocalImpl - Common base class of all ThreadLocal instantiations.
+    // YOU SHOULD NEVER USE THIS DIRECTLY.
     class ThreadLocalImpl {
       void* data;
     public:
       ThreadLocalImpl();
       virtual ~ThreadLocalImpl();
-      void setInstance(void* d);
-      void* getInstance();
+      void setInstance(const void* d);
+      const void* getInstance();
     };
     
+    /// ThreadLocal - A class used to abstract thread-local storage.  It holds,
+    /// for each thread, a pointer a single object of type T.
     template<class T>
     class ThreadLocal : public ThreadLocalImpl {
     public:
       ThreadLocal() : ThreadLocalImpl() { }
+      
+      /// get - Fetches a pointer to the object associated with the current
+      /// thread.  If no object has yet been associated, it returns NULL;
       T* get() { return static_cast<T*>(getInstance()); }
+      
+      // set - Associates a pointer to an object with the current thread.
       void set(T* d) { setInstance(d); }
     };
   }