annotate buf_printf.3 @ 15:9f4f7a266c0b

misc: goodbye doxygen
author David Demelier <markand@malikania.fr>
date Wed, 16 Dec 2020 16:11:10 +0100
parents b1991ee4451d
children 939fe74cd80a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .\"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 .\" buf_printf.3 -- simple string buffer for C
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 .\"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 .\" Copyright (c) 2019-2020 David Demelier <markand@malikania.fr>
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 .\"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 .\" Permission to use, copy, modify, and/or distribute this software for any
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 .\" purpose with or without fee is hereby granted, provided that the above
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 .\" copyright notice and this permission notice appear in all copies.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 .\"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 .\"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 .Dd October 29, 2019-2020
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 .Dt BUF_PRINTF 3
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 .Os
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 .\" NAME
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 .Sh NAME
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 .Nm buf_printf
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 .Nd write a to a buffer using printf(3) like format
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 .\" SYNOPSIS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 .Sh SYNOPSIS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 .In buf.h
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 .Ft bool
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 .Fn buf_printf "struct buf *b" "const char *fmt" "..."
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 .\" DESCRIPTION
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 .Sh DESCRIPTION
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 This function uses the
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 .Xr printf 3
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 format to be appended in the buffer
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 .Fa b .
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 See the
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 .Xr printf 3
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 manual page for a detailed description of
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 .Fa fmt
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 string.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 .\" RETURN VALUE
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 .Sh RETURN VALUE
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 The
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 .Fn buf_printf
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 function returns false in case of error and
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 .Va errno
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 is set to indicate the error.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 .\" ERRORS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 .Sh ERRORS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 .Bl -tag -width Er
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 .It Bq Er ENOMEM
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 Couldn't allocate more memory.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 .El
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 .\" SEE ALSO
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 .Sh SEE ALSO
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 .Xr libbuf 3 ,
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 .Xr buf_vprintf 3 ,
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 .Xr printf 3
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 .\" AUTHORS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 .Sh AUTHORS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 The
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 .Nm libbuf
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 library was written by
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 .An David Demelier <markand@malikania.fr>