Author: Nick Mathewson <nickm@xxxxxxxxxxxxxx>
Date: Sat, 11 Feb 2012 21:05:50 -0500
Subject: Add doxygen for event_base_dump_events
Commit: cad5753587c1b4bed7b76f6572a9205f4f2d3ac9
---
include/event2/event.h | 10 ++++++++++
1 files changed, 10 insertions(+), 0 deletions(-)
diff --git a/include/event2/event.h b/include/event2/event.h
index 01018fa..a795a23 100644
--- a/include/event2/event.h
+++ b/include/event2/event.h
@@ -1239,6 +1239,16 @@ void event_set_mem_functions(
#define EVENT_SET_MEM_FUNCTIONS_IMPLEMENTED
#endif
+/**
+ Writes a human-readable description of all inserted and/or active
+ events to a provided stdio stream.
+
+ This is intended for debugging; its format is not guaranteed to be the same
+ between libevent versions.
+
+ @param base An event_base on which to scan the events.
+ @param output A stdio file to write on.
+ */
void event_base_dump_events(struct event_base *, FILE *);
/** Sets 'tv' to the current time (as returned by gettimeofday()),