aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2022-07-13 23:46:01 -0400
committerDavid Robillard <d@drobilla.net>2022-07-17 18:14:02 -0400
commit779e016962fdd59d333387077387a81555ca5a4b (patch)
tree625e422375f3bf198b28bffd45777aa29246b1c5 /include
parent1eccbe4355685b322194df72b5de2382d5290b3b (diff)
downloadlv2-779e016962fdd59d333387077387a81555ca5a4b.tar.xz
Fix outdated doc comments
Diffstat (limited to 'include')
-rw-r--r--include/lv2/event/event.h16
1 files changed, 4 insertions, 12 deletions
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,