summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlejandro Colomar <alx@kernel.org>2024-05-05 23:33:19 +0200
committerAlejandro Colomar <alx@kernel.org>2024-05-05 23:33:19 +0200
commit14280f011f795e29756d6d50604ba530f55a95e9 (patch)
tree497484c1a5c06564f5b761afe7706ae41d554ab2
parent0e819fbcbb196faf78cd101d1807465489e47caf (diff)
man/man3/a2i.3: Document the consty versions of the functionsliba2i-0.8
Signed-off-by: Alejandro Colomar <alx@kernel.org>
-rw-r--r--man/man3/a2i.316
1 files changed, 13 insertions, 3 deletions
diff --git a/man/man3/a2i.3 b/man/man3/a2i.3
index 8d8a55d..87161c7 100644
--- a/man/man3/a2i.3
+++ b/man/man3/a2i.3
@@ -73,7 +73,7 @@ String-to-integer library
.BI TYPE\~ max );
.YS
.
-.SS Signed functions
+.SS Signed const-generic functions
.B int
.SY a2shh (
.BI signed\~char\~*restrict\~ n ,
@@ -130,7 +130,7 @@ String-to-integer library
.BI long\~long\~ max );
.YS .
.
-.SS Unsigned functions
+.SS Unsigned const-generic functions
.B int
.SY a2uhh (
.BI unsigned\~char\~*restrict\~ n ,
@@ -273,7 +273,7 @@ if (a2s(int64_t, &i, s, NULL, 0, -7, 42) == -1)
.in
.
.SS QChar
-These functions have const-generic wrapper macros.
+These functions are implemented with const-generic wrapper macros.
These decide the const-ness of
.I endp
depending on the const-ness of the input
@@ -292,6 +292,16 @@ is of type
.I endp
will be of type
.IR char\~** .
+.P
+There are functions of the same name,
+which don't have any const parameters.
+And functions named with a
+.I _c
+suffix,
+which use const in both
+.I s
+and
+.IR endp .
.
.
.SH Return value