From 779e016962fdd59d333387077387a81555ca5a4b Mon Sep 17 00:00:00 2001 From: David Robillard Date: Wed, 13 Jul 2022 23:46:01 -0400 Subject: Fix outdated doc comments --- include/lv2/event/event.h | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) (limited to 'include/lv2') diff --git a/include/lv2/event/event.h b/include/lv2/event/event.h index 045ac12..ed5adde 100644 --- a/include/lv2/event/event.h +++ b/include/lv2/event/event.h @@ -255,15 +255,11 @@ typedef struct { If the event is only stored OR passed through, this is not necessary (as the plugin already has 1 implicit reference). + @param callback_data The callback_data field of this struct. + @param event An event received at an input that will not be copied to an output or stored in any way. - @param context The calling context. Like event types, this is a mapped - URI, see lv2_context.h. Simple plugin with just a run() method should - pass 0 here (the ID of the 'standard' LV2 run context). The host - guarantees that this function is realtime safe iff the context is - realtime safe. - PLUGINS THAT VIOLATE THESE RULES MAY CAUSE CRASHES AND MEMORY LEAKS. */ uint32_t (*lv2_event_ref)(LV2_Event_Callback_Data callback_data, @@ -278,15 +274,11 @@ typedef struct { an output or store it internally somehow, it MUST call this function on the event (more information on using non-POD events below). + @param callback_data The callback_data field of this struct. + @param event An event received at an input that will not be copied to an output or stored in any way. - @param context The calling context. Like event types, this is a mapped - URI, see lv2_context.h. Simple plugin with just a run() method should - pass 0 here (the ID of the 'standard' LV2 run context). The host - guarantees that this function is realtime safe iff the context is - realtime safe. - PLUGINS THAT VIOLATE THESE RULES MAY CAUSE CRASHES AND MEMORY LEAKS. */ uint32_t (*lv2_event_unref)(LV2_Event_Callback_Data callback_data, -- cgit v1.2.1