From 84504f215b853b5d5dadb01bbf3a024917f57ed2 Mon Sep 17 00:00:00 2001 From: Reid Spencer Date: Tue, 30 May 2006 08:26:13 +0000 Subject: [PATCH] Properly document the second form of ConstArray::get() llvm-svn: 28553 --- llvm/include/llvm/Constants.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/llvm/include/llvm/Constants.h b/llvm/include/llvm/Constants.h index f0f8146c75b2..dc7e698cf6ba 100644 --- a/llvm/include/llvm/Constants.h +++ b/llvm/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 &); + + /// 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, -- GitLab