From: Nick Mathewson <nickm@torproject.org>
Date: Fri, 10 Apr 2009 20:42:53 +0000 (+0000)
Subject: Better explanation for bufferevent_pair
X-Git-Tag: release-2.0.1-alpha~36
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=decdacfaf8265cf9520eabcf4215501566376d84;p=libevent

Better explanation for bufferevent_pair

svn:r1153
---

diff --git a/include/event2/bufferevent.h b/include/event2/bufferevent.h
index 0da1fb7a..bbb70ad8 100644
--- a/include/event2/bufferevent.h
+++ b/include/event2/bufferevent.h
@@ -405,7 +405,13 @@ bufferevent_filter_new(struct bufferevent *underlying,
 		       void (*free_context)(void *),
 		       void *ctx);
 
-/** Allocate a pair of linked bufferevents DOCDOC */
+/**
+   Allocate a pair of linked bufferevents.  The bufferevents behave as would
+   two bufferevent_sock instances connected to opposite ends of a
+   socketpair(), except that no internel socketpair is allocated.
+
+   @param base The event base to associate with the socketpair.
+ */
 int
 bufferevent_pair_new(struct event_base *base, enum bufferevent_options options,
     struct bufferevent *pair[2]);