summaryrefslogtreecommitdiff
path: root/perl.h
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2019-08-04 18:17:48 -0600
committerKarl Williamson <khw@cpan.org>2019-09-02 21:52:10 -0600
commitb87d9527bf27feeeae2be61d0315b95466718d67 (patch)
tree623e97e4d6f6a3b8bb7983adaff6db3c77a1b353 /perl.h
parentea348ccb78d37293d5fc7720b8149bc1ac898065 (diff)
downloadperl-b87d9527bf27feeeae2be61d0315b95466718d67.tar.gz
perlapi: Document my_strotod, Strtod
Diffstat (limited to 'perl.h')
-rw-r--r--perl.h28
1 files changed, 27 insertions, 1 deletions
diff --git a/perl.h b/perl.h
index 647ec7123f..2f8c25ac10 100644
--- a/perl.h
+++ b/perl.h
@@ -6692,7 +6692,33 @@ cannot have changed since the precalculation.
#endif /* !USE_LOCALE_NUMERIC */
#define Atof my_atof
-/* XXX document this , maybe other similar ones*/
+
+/*
+
+=head1 Numeric functions
+
+=for apidoc AmTR|NV|Strtod|NN const char * const s|NULLOK char ** e
+
+This is a synonym for L</my_strtod>.
+
+=for apidoc AmTR|NV|Strtol|NN const char * const s|NULLOK char ** e|int base
+
+Platform and configuration independent C<strtol>. This expands to the
+appropriate C<strotol>-like function based on the platform and F<Configure>
+options>. For example it could expand to C<strtoll> or C<strtoq> instead of
+C<strtol>.
+
+=for apidoc AmTR|NV|Strtoul|NN const char * const s|NULLOK char ** e|int base
+
+Platform and configuration independent C<strtoul>. This expands to the
+appropriate C<strotoul>-like function based on the platform and F<Configure>
+options>. For example it could expand to C<strtoull> or C<strtouq> instead of
+C<strtoul>.
+
+=cut
+
+*/
+
#define Strtod my_strtod
#if defined(HAS_STRTOD) \