diff options
author | Owen Anderson <resistor@mac.com> | 2010-07-28 22:30:53 +0000 |
---|---|---|
committer | Owen Anderson <resistor@mac.com> | 2010-07-28 22:30:53 +0000 |
commit | e850e6e162064232d06a3638112fb7d000b27bc4 (patch) | |
tree | ca51647b7cee77b833a3180898b27d817568b7fa /include | |
parent | 9da5c997c0015079c9f082759ea07ea09f285333 (diff) | |
download | external_llvm-e850e6e162064232d06a3638112fb7d000b27bc4.zip external_llvm-e850e6e162064232d06a3638112fb7d000b27bc4.tar.gz external_llvm-e850e6e162064232d06a3638112fb7d000b27bc4.tar.bz2 |
Add more doxygen comments for llvm::ThreadLocal.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@109683 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include')
-rw-r--r-- | include/llvm/System/ThreadLocal.h | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/include/llvm/System/ThreadLocal.h b/include/llvm/System/ThreadLocal.h index 39b1e64..3d44f62 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 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); } }; } |