From e850e6e162064232d06a3638112fb7d000b27bc4 Mon Sep 17 00:00:00 2001 From: Owen Anderson Date: Wed, 28 Jul 2010 22:30:53 +0000 Subject: [PATCH] Add more doxygen comments for llvm::ThreadLocal. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@109683 91177308-0d34-0410-b5e6-96231b3b80d8 --- include/llvm/System/ThreadLocal.h | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/include/llvm/System/ThreadLocal.h b/include/llvm/System/ThreadLocal.h index 39b1e64be0c..3d44f62e959 100644 --- a/include/llvm/System/ThreadLocal.h +++ b/include/llvm/System/ThreadLocal.h @@ -19,6 +19,8 @@ namespace llvm { namespace sys { + // ThreadLocalImpl - Common base class of all ThreadLocal instantiations. + // YOU SHOULD NEVER USE THIS DIRECTLY. class ThreadLocalImpl { void* data; public: @@ -28,11 +30,18 @@ namespace llvm { 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 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(getInstance()); } + + // set - Associates a pointer to an object with the current thread. void set(T* d) { setInstance(d); } }; }