add man pages for array API

This commit is contained in:
leitner
2003-09-01 17:59:12 +00:00
parent 9e8043f4d8
commit c845e84c37
17 changed files with 368 additions and 0 deletions

21
array/array_fail.3 Normal file
View File

@@ -0,0 +1,21 @@
.TH array_fail 3
.SH NAME
array_fail \- switch array to have failed
.SH SYNTAX
.B #include <array.h>
void \fBarray_fail\fP(array* \fIx\fR);
array \fIx\fR;
array_fail(&\fIx\fR);
.SH DESCRIPTION
If \fIx\fR is allocated, array_fail frees the region that \fIx\fR points
to, and switches \fIx\fR to have failed.
If \fIx\fR is unallocated, array_fail simply switches \fIx\fR to have
failed.
If \fIx\fR has already failed, array_fail has no effect.
.SH "SEE ALSO"
array_allocate(3), array_reset(3)