Minor code tweaks

darcs-hash:20070416201053-ac50b-99d3ee51ef2b3642c737c3809bc2a4bfbe103b67.gz

1 files changed, 6 insertions, 0 deletions

diff --git a/event.h b/event.h
index 9bd3f81b..cb99c73f 100644
--- a/event.h
+++ b/event.h
@@ -97,6 +97,9 @@ void event_remove( event_t *event );
 /**
    Return all events which match the specified event class 
 
+   This function is safe to call from a signal handler _ONLY_ if the
+   out parameter is null.
+
    \param criterion Is the class of events to return. If the criterion has a non-null function_name, only events which trigger the specified function will return.
    \param out the list to add events to. May be 0, in which case no events will be added, but the result count will still be valid
    
@@ -111,6 +114,9 @@ int event_get( event_t *criterion, array_list_t *out );
    called. If event is a null-pointer, all pending events are
    dispatched.
 
+   This function is safe to call from a signal handler _ONLY_ if the
+   event parameter is for a signal.
+
    \param event the specific event whose handlers should fire
 */
 void event_fire( event_t *event );