From a800b913ac473b6c9bd4b1765f4efbea4bae1393 Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Fri, 26 Apr 2013 11:36:43 -0400 Subject: More documentation for finalization feature --- bufferevent-internal.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'bufferevent-internal.h') diff --git a/bufferevent-internal.h b/bufferevent-internal.h index 09cdb351..9ecede17 100644 --- a/bufferevent-internal.h +++ b/bufferevent-internal.h @@ -252,11 +252,13 @@ struct bufferevent_ops { */ int (*disable)(struct bufferevent *, short); - /** DOCUMENT */ + /** Detatches the bufferevent from related data structures. Called as + * soon as its reference count reaches 0. */ void (*unlink)(struct bufferevent *); /** Free any storage and deallocate any extra data or structures used - in this implementation. DOCUMENT + in this implementation. Called when the bufferevent is + finalized. */ void (*destruct)(struct bufferevent *); -- cgit v1.2.1