maint: update copyright
[gnulib.git] / doc / c-strtod.texi
1 @c Documentation of gnulib module 'c-strtod'.
2
3 @c Copyright (C) 2008-2014 Free Software Foundation, Inc.
4
5 @c Permission is granted to copy, distribute and/or modify this document
6 @c under the terms of the GNU Free Documentation License, Version 1.3 or
7 @c any later version published by the Free Software Foundation; with no
8 @c Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
9 @c Texts.  A copy of the license is included in the ``GNU Free
10 @c Documentation License'' file as part of this distribution.
11
12 The @code{c-strtod} module contains a string to number (@samp{double})
13 conversion function operating on single-byte character strings, that operates
14 as if the locale encoding was ASCII.
15 (The "C" locale on many systems has the locale encoding "ASCII".)
16
17 The function is:
18 @smallexample
19 extern double c_strtod (const char *string, char **endp);
20 @end smallexample
21
22 In particular, only a period @samp{.} is accepted as decimal point, even
23 when the current locale's notion of decimal point is a comma @samp{,},
24 and no characters outside the basic character set are accepted.
25
26 On platforms without @code{strtod_l}, this function is not safe for use in
27 multi-threaded applications since it calls @code{setlocale}.