Add a comment on evthread_enable_lock_debuging.

diff --git a/include/event2/thread.h b/include/event2/thread.h
index 0540b7f954de90d3128c6ed290bb4e9e042a7c4f..762d8a5d62da10bcdce67ec07aac3ca3cc3966cd 100644 (file)
--- a/include/event2/thread.h
+++ b/include/event2/thread.h
@@ -172,7 +172,9 @@ int evthread_use_pthreads(void);
 
 #endif
 
-/* XXXXX */
+/** Enable debugging wrappers around the current lock callbacks.  If Libevent
+ * makes one of several common locking errors, exit with an assertion failure.
+ **/
 void evthread_enable_lock_debuging(void);
 
 #endif /* _EVENT_DISABLE_THREAD_SUPPORT */