diff options
author | David Robillard <d@drobilla.net> | 2014-11-25 00:23:48 -0500 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2014-11-25 00:23:48 -0500 |
commit | 68a4dc89f5e00aa6e2780f4f96011b92961b7a80 (patch) | |
tree | 22882da1f402bd6067415e687f9061c77680c198 /lv2/lv2plug.in/ns/ext/event/event.h | |
parent | 1754a6fe0866fcf84846722f45042caa698d1aea (diff) | |
download | lv2-68a4dc89f5e00aa6e2780f4f96011b92961b7a80.tar.xz |
Single-page API documentation with unified style.
Diffstat (limited to 'lv2/lv2plug.in/ns/ext/event/event.h')
-rw-r--r-- | lv2/lv2plug.in/ns/ext/event/event.h | 22 |
1 files changed, 10 insertions, 12 deletions
diff --git a/lv2/lv2plug.in/ns/ext/event/event.h b/lv2/lv2plug.in/ns/ext/event/event.h index abc0b96..260dae1 100644 --- a/lv2/lv2plug.in/ns/ext/event/event.h +++ b/lv2/lv2plug.in/ns/ext/event/event.h @@ -16,18 +16,12 @@ */ /** - @file event.h - C API for the LV2 Event extension <http://lv2plug.in/ns/ext/event>. - - This extension is a generic transport mechanism for time stamped events - of any type (e.g. MIDI, OSC, ramps, etc). Each port can transport mixed - events of any type; the type of events and timestamps are defined by a URI - which is mapped to an integer by the host for performance reasons. - - This extension requires the host to support the LV2 URI Map extension. - Any host which supports this extension MUST guarantee that any call to - the LV2 URI Map uri_to_id function with the URI of this extension as the - 'map' argument returns a value within the range of uint16_t. + @defgroup event Event + + Generic time-stamped events, see <http://lv2plug.in/ns/ext/event> for + details. + + @{ */ #ifndef LV2_EVENT_H @@ -292,3 +286,7 @@ typedef struct { #endif #endif /* LV2_EVENT_H */ + +/** + @} +*/ |