aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEric Botcazou <ebotcazou@adacore.com>2020-11-16 12:03:31 +0100
committerPierre-Marie de Rodat <derodat@adacore.com>2020-12-14 10:51:48 -0500
commit49ea96b4d883105e44a63f304584088928732975 (patch)
tree5cc61ff3d6f09307a48ac3c38d54cf2d38c1466f
parent62c5ea5228857a910b38df91c2b0fe28f4d1ddc8 (diff)
downloadgcc-49ea96b4d883105e44a63f304584088928732975.zip
gcc-49ea96b4d883105e44a63f304584088928732975.tar.gz
gcc-49ea96b4d883105e44a63f304584088928732975.tar.bz2
[Ada] Adjust documentation of System.Img_Util.Set_Decimal_Digits
gcc/ada/ * libgnat/s-imguti.ads (Set_Decimal_Digits): Adjust documentation.
-rw-r--r--gcc/ada/libgnat/s-imguti.ads21
1 files changed, 12 insertions, 9 deletions
diff --git a/gcc/ada/libgnat/s-imguti.ads b/gcc/ada/libgnat/s-imguti.ads
index f980bb7..6e21c65 100644
--- a/gcc/ada/libgnat/s-imguti.ads
+++ b/gcc/ada/libgnat/s-imguti.ads
@@ -45,14 +45,17 @@ package System.Img_Util is
Exp : Natural);
-- Sets the image of Digs (1 .. NDigs), which is a string of decimal digits
-- preceded by either a minus sign or a space, i.e. the integer image of
- -- the value in units of delta of a decimal fixed point type with the given
- -- Scale, starting at S (P + 1), updating P to point to the last character
- -- stored, the caller promises that the buffer is large enough and no check
- -- is made for this. Constraint_Error will not necessarily be raised if the
- -- requirement is violated since it is perfectly valid to compile this unit
- -- with checks off. The Fore, Aft and Exp values can be set to any valid
- -- values for the case of use by Text_IO.Decimal_IO. Note that there is no
- -- leading space stored. The call may destroy the value in Digs, which is
- -- why Digs is in-out (this happens if rounding is required).
+ -- the value in units of delta if this is for a decimal fixed point type
+ -- with the given Scale, or the integer image of the value converted to an
+ -- implicit decimal fixed point type with the given Scale if this is for an
+ -- ordinary fixed point type, starting at S (P + 1), updating P to point to
+ -- the last character stored. The caller promises that the buffer is large
+ -- enough and therefore no check is made for it. Constraint_Error will not
+ -- necessarily be raised if the requirement is violated since it is valid
+ -- to compile this unit with checks off. The Fore, Aft and Exp values can
+ -- be set to any valid values for the case of use by Text_IO.Decimal_IO or
+ -- Text_IO.Fixed_IO. Note that there is no leading space stored. The call
+ -- may destroy the value in Digs, which is why Digs is in-out (this happens
+ -- if rounding is required).
end System.Img_Util;