[llvm-commits] CVS: llvm/include/llvm/Constants.h

[Reid Spencer]

Changes in directory llvm/include/llvm:

Constants.h updated: 1.81 -> 1.82
---
Log message:

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


---
Diffs of the changes:  (+7 -0)

 Constants.h |    7 +++++++
 1 files changed, 7 insertions(+)


Index: llvm/include/llvm/Constants.h
diff -u llvm/include/llvm/Constants.h:1.81 llvm/include/llvm/Constants.h:1.82
--- llvm/include/llvm/Constants.h:1.81	Tue May 30 03:23:18 2006
+++ llvm/include/llvm/Constants.h	Tue May 30 03:26:13 2006
@@ -345,6 +345,13 @@
 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,