From: Reid Spencer <rspencer@reidspencer.com>
Date: Tue, 19 Dec 2006 01:34:39 +0000 (+0000)
Subject: Correct the description of ConstantInt::isValueValidForType.
X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=6d0483a7a365338e17537366c6c934edef2ef726;p=oota-llvm.git

Correct the description of ConstantInt::isValueValidForType.


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

diff --git a/include/llvm/Constants.h b/include/llvm/Constants.h
index 5e463443ba8..2a0c62423d6 100644
--- a/include/llvm/Constants.h
+++ b/include/llvm/Constants.h
@@ -181,9 +181,11 @@ public:
 
   /// This static method returns true if the type Ty is big enough to 
   /// represent the value V. This can be used to avoid having the get method 
-  /// assert when V is larger than Ty can represent. Note that values are
-  /// always treated as unsigned so if the intention is to represent a signed
-  /// type, you must do the conversion first.
+  /// assert when V is larger than Ty can represent. Note that there are two
+  /// versions of this method, one for unsigned and one for signed integers.
+  /// Although ConstantInt canonicalizes everything to an unsigned integer, 
+  /// the signed version avoids callers having to convert a signed quantity
+  /// to the appropriate unsigned type before calling the method.
   /// @returns true if V is a valid value for type Ty
   /// @brief Determine if the value is in range for the given type.
   static bool isValueValidForType(const Type *Ty, uint64_t V);