Support: Cleanup ScaledNumber::getAdjusted() doc
authorDuncan P. N. Exon Smith <dexonsmith@apple.com>
Fri, 20 Jun 2014 21:44:36 +0000 (21:44 +0000)
committerDuncan P. N. Exon Smith <dexonsmith@apple.com>
Fri, 20 Jun 2014 21:44:36 +0000 (21:44 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@211407 91177308-0d34-0410-b5e6-96231b3b80d8

include/llvm/Support/ScaledNumber.h

index b5a1168f67af82651bd73f7a745a6455236c7bca..8b7c5d0c4a0460f7369111871fe79ef73b2f1381 100644 (file)
@@ -67,10 +67,7 @@ inline std::pair<uint64_t, int16_t> getRounded64(uint64_t Digits, int16_t Scale,
 
 /// \brief Adjust a 64-bit scaled number down to the appropriate width.
 ///
-/// Adjust a soft float with 64-bits of digits down, keeping as much
-/// information as possible, and rounding up on half.
-///
-/// \pre Adding 1 to \c Scale will not overflow INT16_MAX.
+/// \pre Adding 64 to \c Scale will not overflow INT16_MAX.
 template <class DigitsT>
 inline std::pair<DigitsT, int16_t> getAdjusted(uint64_t Digits,
                                                int16_t Scale = 0) {