view buf_clear.3 @ 15:9f4f7a266c0b

misc: goodbye doxygen
author David Demelier <markand@malikania.fr>
date Wed, 16 Dec 2020 16:11:10 +0100
parents ef83533c3417
children d87e84936795
line wrap: on
line source

.\"
.\" buf_clear.3 -- simple string buffer for C
.\"
.\" Copyright (c) 2019-2020 David Demelier <markand@malikania.fr>
.\"
.\" Permission to use, copy, modify, and/or distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd October 29, 2019-2020
.Dt BUF_CLEAR 3
.Os
.\" NAME
.Sh NAME
.Nm buf_clear
.Nd clear the buffer
.\" SYNOPSIS
.Sh SYNOPSIS
.In buf.h
.Ft void
.Fn buf_clear "struct buf *b"
.\" DESCRIPTION
.Sh DESCRIPTION
This function only change the string length, use
.Xr buf_shrink 3
if you want to reduce memory usage.
.\" SEE ALSO
.Sh SEE ALSO
.Xr libbuf 3 ,
.Xr buf_shrink 3
.\" AUTHORS
.Sh AUTHORS
The
.Nm libbuf
library was written by
.An David Demelier <markand@malikania.fr>