From: Chris Lattner <sabre@nondot.org>
Date: Tue, 10 Apr 2007 16:33:06 +0000 (+0000)
Subject: fix a comment bug Reid noticed
X-Git-Url: http://plrg.eecs.uci.edu/git/?a=commitdiff_plain;h=2b4c23438838034ee2a812f3cb094a9742b272f6;p=oota-llvm.git

fix a comment bug Reid noticed


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

diff --git a/include/llvm/ADT/APInt.h b/include/llvm/ADT/APInt.h
index c514d24bcf1..d9470ee3c80 100644
--- a/include/llvm/ADT/APInt.h
+++ b/include/llvm/ADT/APInt.h
@@ -281,8 +281,9 @@ public:
     return *this != 0;
   }
 
-  /// getLimitedValue - Return this value, or return all ones if it is too large
-  /// to return.
+  /// getLimitedValue - If this value is smaller than the specified limit,
+  /// return it, otherwise return the limit value.  This causes the value
+  /// to saturate to the limit.
   uint64_t getLimitedValue(uint64_t Limit = ~0ULL) const {
     return (getActiveBits() > 64 || getZExtValue() > Limit) ?
       Limit :  getZExtValue();