fix a comment bug Reid noticed

[oota-llvm.git] / include / llvm / ADT / APInt.h

diff --git a/include/llvm/ADT/APInt.h b/include/llvm/ADT/APInt.h
index c514d24bcf13484d45de9f8669895d12487c278f..d9470ee3c80a4d52de4a179141b34371b504afea 100644 (file)
--- 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();