diff options
| author | Nick Mathewson <nickm@torproject.org> | 2013-11-21 11:30:04 -0500 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2013-11-21 11:30:04 -0500 |
| commit | 6e67b51023e507b15baecfbae1f20e8ede27222f (patch) | |
| tree | ccda3d522f541d4b1181fe50b9cdc1c0a6dd10da /include | |
| parent | a60632a1ec6649dfa0be175d064b1ca6192cc5bf (diff) | |
| download | libevent-6e67b51023e507b15baecfbae1f20e8ede27222f.tar.gz | |
Small doxygen tweaks
Diffstat (limited to 'include')
| -rw-r--r-- | include/event2/event.h | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/include/event2/event.h b/include/event2/event.h index baf0d241..389924c0 100644 --- a/include/event2/event.h +++ b/include/event2/event.h @@ -54,7 +54,7 @@ @section usage Standard usage - Every program that uses Libevent must inclurde the <event2/event.h> + Every program that uses Libevent must include the <event2/event.h> header, and pass the -levent flag to the linker. (You can instead link -levent_core if you only want the main event and buffered IO-based code, and don't want to link any protocol code.) @@ -124,9 +124,11 @@ @section timers Timers Libevent can also be used to create timers that invoke a callback after a - certain amount of time has expired. The evtimer_new() function returns + certain amount of time has expired. The evtimer_new() macro returns an event struct to use as a timer. To activate the timer, call evtimer_add(). Timers can be deactivated by calling evtimer_del(). + (These macros are thin wrappers around event_new(), event_add(), + and event_del(); you can also use those instead.) @section evdns Asynchronous DNS resolution |