commented purging of timer events on timer destruction

diff --git a/lib/isc/include/isc/timer.h b/lib/isc/include/isc/timer.h
index de7070e72fad74316ceab360f8ae5f6a5a9a9f4d..4c9a71f0acdaaa1824f97b872de511e32010ae6f 100644 (file)
--- a/lib/isc/include/isc/timer.h
+++ b/lib/isc/include/isc/timer.h
@@ -266,6 +266,11 @@ isc_timer_detach(isc_timer_t **timerp);
  *             The timer will detach from its task
  *
  *             All resources used by the timer have been freed
+ *
+ *             Any events already posted by the timer will be purged.
+ *             Therefore, if isc_timer_detach() is called in the context
+ *             of the timer's task, it is guaranteed that no more
+ *             timer event callbacks will run after the call.
  */
 
 isc_result_t