Dcoument that the opauque value used to construct QNaNs is truncated

as necessary.

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

diff --git a/include/llvm/ADT/APFloat.h b/include/llvm/ADT/APFloat.h
index 1ff92418ee866db7d2bb3b914af4e5604f720116..928ecc0c3cf579e3df588f8c1cdcd9823deec403 100644 (file)
--- a/include/llvm/ADT/APFloat.h
+++ b/include/llvm/ADT/APFloat.h
@@ -192,7 +192,7 @@ namespace llvm {
     ///
     /// \param Negative - True iff the NaN generated should be negative.
     /// \param type - The unspecified fill bits for creating the NaN, 0 by
-    /// default.
+    /// default.  The value is truncated as necessary.
     static APFloat getNaN(const fltSemantics &Sem, bool Negative = false,
                           unsigned type = 0) {
       return APFloat(Sem, fcNaN, Negative, type);