I think it needs some text as well, there isn't much point in just listing the function. bufferevent_settimeout is also missing a description.
I'm away for the next two weeks but I'll look when I get back. On Mon, May 15, 2017 at 07:41:57PM +0200, Anton Lindqvist wrote: > Hi, > The bufferevent_setwatermark function is not mentioned in event(3). > Maybe the function deserves to be documented under the "BUFFERED EVENTS" > section but I know too little about the API to determine if that would > be useful. Some docs regarding the function can however be found in the > event.h header. > > Spotted while reading the tmux source. > > Index: event.3 > =================================================================== > RCS file: /cvs/src/lib/libevent/event.3,v > retrieving revision 1.52 > diff -u -p -r1.52 event.3 > --- event.3 17 Jul 2016 11:21:07 -0000 1.52 > +++ event.3 15 May 2017 17:32:36 -0000 > @@ -67,7 +67,8 @@ > .Nm bufferevent_read , > .Nm bufferevent_enable , > .Nm bufferevent_disable , > -.Nm bufferevent_settimeout > +.Nm bufferevent_settimeout , > +.Nm bufferevent_setwatermark > .Nd execute a function when a specific event occurs > .Sh SYNOPSIS > .In sys/time.h > @@ -154,6 +155,8 @@ > .Fn "bufferevent_disable" "struct bufferevent *bufev" "short event" > .Ft void > .Fn "bufferevent_settimeout" "struct bufferevent *bufev" "int timeout_read" > "int timeout_write" > +.Ft void > +.Fn "bufferevent_setwatermark" "struct bufferevent *bufev" "short events" > "size_t lowmark" "size_t highmark" > .Sh DESCRIPTION > The > .Nm event >
