Properly document the second form of ConstArray::get()

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@28553 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/include/llvm/Constants.h b/include/llvm/Constants.h
index f0f8146c75b2e57fb2ef7619ac35c8ba3de0883b..dc7e698cf6ba4506d9d3ff6e4266b8a8d3ae5c55 100644 (file)
--- a/include/llvm/Constants.h
+++ b/include/llvm/Constants.h
@@ -345,6 +345,13 @@ protected:
 public:
   /// get() - Static factory methods - Return objects of the specified value
   static Constant *get(const ArrayType *T, const std::vector<Constant*> &);
+
+  /// This method constructs a ConstantArray and initializes it with a text
+  /// string. The default behavior (len==0) causes the null terminator to
+  /// be copied as well. However, in some situations this is not desired so
+  /// if len <= Initializer.length() (but not 0) then only that portion of
+  /// the string is copied and there is no null termination. If len >
+  /// than Initializer's length then the function asserts out (don't do that).
   static Constant *get(const std::string &Initializer, unsigned len = 0);
 
   /// getType - Specialize the getType() method to always return an ArrayType,