aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/doc
diff options
context:
space:
mode:
authorDavid M. Syzdek <david@syzdek.net>2022-01-21 02:54:34 -0900
committerDavid M. Syzdek <david@syzdek.net>2022-01-21 02:54:34 -0900
commitc667b9e76dd4e5f09035bbed008d385aa467ad3d (patch)
tree56a4d441ab3990f4037baf5ba9fe68cbf8ee3a43 /doc
parent8c30baee1e514912b0744d67654e8421a175c812 (diff)
downloadtinyrad-c667b9e76dd4e5f09035bbed008d385aa467ad3d.tar.gz
tinyrad-c667b9e76dd4e5f09035bbed008d385aa467ad3d.tar.bz2
tinyrad-c667b9e76dd4e5f09035bbed008d385aa467ad3d.tar.xz
tinyrad-c667b9e76dd4e5f09035bbed008d385aa467ad3d.zip
doc: updating return values in stack and array man pages
Diffstat (limited to 'doc')
-rw-r--r--doc/mans/tinyrad_array.3.in11
-rw-r--r--doc/mans/tinyrad_stack.3.in6
2 files changed, 13 insertions, 4 deletions
diff --git a/doc/mans/tinyrad_array.3.in b/doc/mans/tinyrad_array.3.in
index 09f2019..ee82eaa 100644
--- a/doc/mans/tinyrad_array.3.in
+++ b/doc/mans/tinyrad_array.3.in
@@ -62,8 +62,15 @@ TinyRad (libtinyrad, -ltinyrad)
62 To be written. 62 To be written.
63 63
64.SH RETURN VALUES 64.SH RETURN VALUES
65On success, the functions return TINYRAD_SUCCESS, otherwise a specific error 65\fBtinyrad_array_get\fR() returns \fINULL\fR if an error occurs, otherwise a
66is returned. 66pointer to the object is returned. \fBtinyrad_array_search\fR() returns -1 if
67an error occurs, otherwise the index position of the requested object is
68returned.
69.sp
70Upon success, \fBtinyrad_array_insert\fR() and \fBtinyrad_array_remove\fR
71return the index position of the object added to or removed from the
72array, otherwise -2 is returned if a memory error occured and -1 for all
73other errors.
67.SH SEE ALSO 74.SH SEE ALSO
68.BR tinyrad (3), 75.BR tinyrad (3),
69.BR tinyrad_stack (3), 76.BR tinyrad_stack (3),
diff --git a/doc/mans/tinyrad_stack.3.in b/doc/mans/tinyrad_stack.3.in
index 832780e..0c76ee8 100644
--- a/doc/mans/tinyrad_stack.3.in
+++ b/doc/mans/tinyrad_stack.3.in
@@ -50,8 +50,10 @@ TinyRad (libtinyrad, -ltinyrad)
50 To be written. 50 To be written.
51 51
52.SH RETURN VALUES 52.SH RETURN VALUES
53On success, the functions return TINYRAD_SUCCESS, otherwise a specific error 53\fBtinyrad_array_pop\fR() and \fBtinyrad_array_peek\fR return \fINULL\fR
54is returned. 54if an error occurs, otherwise a pointer to the object is returned.
55Upon success, \fBtinyrad_array_push\fR() returns 0, otherwise -2 if a
56memory error occured and -1 for all other errors.
55.SH SEE ALSO 57.SH SEE ALSO
56.BR tinyrad (3), 58.BR tinyrad (3),
57.BR tinyrad_array (3), 59.BR tinyrad_array (3),