aboutsummaryrefslogtreecommitdiffstats
path: root/man3/libsimple_minimise_number_string.3
diff options
context:
space:
mode:
Diffstat (limited to 'man3/libsimple_minimise_number_string.3')
-rw-r--r--man3/libsimple_minimise_number_string.314
1 files changed, 13 insertions, 1 deletions
diff --git a/man3/libsimple_minimise_number_string.3 b/man3/libsimple_minimise_number_string.3
index 310b725..19533c6 100644
--- a/man3/libsimple_minimise_number_string.3
+++ b/man3/libsimple_minimise_number_string.3
@@ -1,6 +1,7 @@
-.TH LIBSIMPLE_MINIMISE_NUMBER_STRING 3 2018-10-31 libsimple
+.TH LIBSIMPLE_MINIMISE_NUMBER_STRING 3 libsimple
.SH NAME
libsimple_minimise_number_string \- ninimise a numerical string
+
.SH SYNOPSIS
.nf
#include <libsimple.h>
@@ -14,6 +15,7 @@ char *libsimple_minimise_number_string(char *\fIs\fP);
.PP
Link with
.IR \-lsimple .
+
.SH DESCRIPTION
The
.BR libsimple_minimise_number_string ()
@@ -21,15 +23,18 @@ function minimises a string representing a real value with
the assumption that the string is on the format
.B [+-]\e?[0-9]*\e(\e.[0-9]*\e)\e?
(repeating decimals are not supported).
+
.SH RETURN VALUE
The
.BR libsimple_minimise_number_string ()
function returns the pointer
.IR s .
+
.SH ERRORS
The
.BR libsimple_minimise_number_string ()
function cannot fail.
+
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
@@ -48,17 +53,24 @@ T{
.BR libsimple_minimise_number_string ()
T} Async-cancel safety AC-Safe
.TE
+
.SH EXAMPLES
None.
+
.SH APPLICATION USAGE
None.
+
.SH RATIONALE
None.
+
.SH FUTURE DIRECTIONS
None.
+
.SH NOTES
None.
+
.SH BUGS
None.
+
.SH SEE ALSO
.BR libsimple_timespectostr (3)