Adding a collector name attribute to Function in the IR. These

[oota-llvm.git] / include / llvm / Support / StringPool.h

diff --git a/include/llvm/Support/StringPool.h b/include/llvm/Support/StringPool.h
index 07b2a8ddde2afd262a117fed63c599eb2a4b3e69..7ac2b147c34dc7eb54c0ff355f1166cb676a3ce5 100644 (file)
--- a/include/llvm/Support/StringPool.h
+++ b/include/llvm/Support/StringPool.h
@@ -29,7 +29,7 @@
 #ifndef LLVM_SUPPORT_STRINGPOOL_H
 #define LLVM_SUPPORT_STRINGPOOL_H
 
-#include <llvm/ADT/StringMap.h>
+#include "llvm/ADT/StringMap.h"
 #include <new>
 #include <cassert>
 
@@ -41,6 +41,8 @@ namespace llvm {
   /// string. Strings are removed automatically as PooledStringPtrs are
   /// destroyed.
   class StringPool {
+    /// PooledString - This is the value of an entry in the pool's interning
+    /// table.
     struct PooledString {
       StringPool *Pool;  ///< So the string can remove itself.
       unsigned Refcount; ///< Number of referencing PooledStringPtrs.
@@ -59,7 +61,14 @@ namespace llvm {
     StringPool();
     ~StringPool();
     
+    /// intern - Adds a string to the pool and returns a reference-counted
+    /// pointer to it. No additional memory is allocated if the string already
+    /// exists in the pool.
     PooledStringPtr intern(const char *Begin, const char *End);
+    
+    /// intern - Adds a null-terminated string to the pool and returns a
+    /// reference-counted pointer to it. No additional memory is allocated if
+    /// the string already exists in the pool.
     inline PooledStringPtr intern(const char *Str);
   };