summaryrefslogtreecommitdiff
path: root/numeric.c
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2020-07-22 16:22:27 -0600
committerKarl Williamson <khw@cpan.org>2020-09-13 21:48:27 -0600
commitb1de2493b5ce238fa84597ffde8bdba7659dbb81 (patch)
tree3783a8d86dd485993f79755ed58065b0119513c1 /numeric.c
parentce9aa77f2f9462115cf7095133d7ed2ee773a69f (diff)
downloadperl-b1de2493b5ce238fa84597ffde8bdba7659dbb81.tar.gz
Document my_atof
Diffstat (limited to 'numeric.c')
-rw-r--r--numeric.c13
1 files changed, 12 insertions, 1 deletions
diff --git a/numeric.c b/numeric.c
index a476881cf9..5fb7623136 100644
--- a/numeric.c
+++ b/numeric.c
@@ -1467,7 +1467,18 @@ S_mulexp10(NV value, I32 exponent)
NV
Perl_my_atof(pTHX_ const char* s)
{
- /* 's' must be NUL terminated */
+
+/*
+=for apidoc my_atof
+
+L<C<atof>(3)>, but properly works with Perl locale handling, accepting a dot
+radix character always, but also the current locale's radix character if and
+only if called from within the lexical scope of a Perl C<use locale> statement.
+
+N.B. C<s> must be NUL terminated.
+
+=cut
+*/
NV x = 0.0;