aboutsummaryrefslogtreecommitdiffstats
path: root/lv2/event
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2020-04-06 13:51:22 +0200
committerDavid Robillard <d@drobilla.net>2020-04-10 19:46:04 +0200
commita43ca05578cc2fefdd1bab8cd564332eaf9bd191 (patch)
tree2c04db1b6e8b89e24d9afc21946355c9c8ecc933 /lv2/event
parent802614f60290df2ed452d14499ed71651c246350 (diff)
downloadlv2-a43ca05578cc2fefdd1bab8cd564332eaf9bd191.tar.xz
Remove most uses of "e.g." in documentation
This causes typesetting issues in some cases (because it is interpreted as the end of a sentence), and it's probably more accessible to write out fully anyway.
Diffstat (limited to 'lv2/event')
-rw-r--r--lv2/event/event-helpers.h2
-rw-r--r--lv2/event/event.h2
-rw-r--r--lv2/event/event.meta.ttl16
3 files changed, 10 insertions, 10 deletions
diff --git a/lv2/event/event-helpers.h b/lv2/event/event-helpers.h
index af72d76..ca3abec 100644
--- a/lv2/event/event-helpers.h
+++ b/lv2/event/event-helpers.h
@@ -90,7 +90,7 @@ lv2_event_buffer_new(uint32_t capacity, uint16_t stamp_type)
/** An iterator over an LV2_Event_Buffer.
*
* Multiple simultaneous read iterators over a single buffer is fine,
- * but changing the buffer invalidates all iterators (e.g. RW Lock). */
+ * but changing the buffer invalidates all iterators. */
typedef struct {
LV2_Event_Buffer* buf;
uint32_t offset;
diff --git a/lv2/event/event.h b/lv2/event/event.h
index 30d73a6..aa67390 100644
--- a/lv2/event/event.h
+++ b/lv2/event/event.h
@@ -81,7 +81,7 @@ typedef struct {
The frames portion of timestamp. The units used here can optionally be
set for a port (with the lv2ev:timeUnits property), otherwise this is
audio frames, corresponding to the sample_count parameter of the LV2 run
- method (e.g. frame 0 is the first frame for that call to run).
+ method (frame 0 is the first frame for that call to run).
*/
uint32_t frames;
diff --git a/lv2/event/event.meta.ttl b/lv2/event/event.meta.ttl
index 22d8f92..80593ce 100644
--- a/lv2/event/event.meta.ttl
+++ b/lv2/event/event.meta.ttl
@@ -139,8 +139,8 @@ An ev:EventPort contains an LV2_Event_Buffer which contains a sequence of these
events. The binary format of LV2 events is defined by the LV2_Event struct in
event.h.
-Specific event types (e.g. MIDI, OSC) are defined by extensions, and should be
-rdfs:subClassOf this class.
+Specific event types (such as MIDI or OSC) are defined by extensions, and
+should be rdfs:subClassOf this class.
"""^^lv2:Markdown .
@@ -164,8 +164,8 @@ frames (in the sample rate passed to intantiate), and the subframes field is
ev:generic
lv2:documentation """
-Indicates that this port does something meaningful for any event type
-(e.g. event mixers, delays, serialisers, etc).
+Indicates that this port does something meaningful for any event type. This is
+useful for things like event mixers, delays, serialisers, and so on.
If this property is set, hosts should consider the port suitable for any type
of event. Otherwise, hosts should consider the port 'appropriate' only for the
@@ -188,10 +188,10 @@ set (use ev:inheritsEvent for that).
Plugins with event input ports must always gracefully handle any type of event,
even if it does not 'support' it. This property should always be set for event
types the plugin understands/generates so hosts can discover plugins
-appropriate for a given scenario (e.g. plugins with a MIDI input). Hosts are
-not expected to consider event ports suitable for some type of event if the
-relevant :supportsEvent property is not set, unless the ev:generic property for
-that port is also set.
+appropriate for a given scenario (for example, plugins with a MIDI input).
+Hosts are not expected to consider event ports suitable for some type of event
+if the relevant :supportsEvent property is not set, unless the ev:generic
+property for that port is also set.
"""^^lv2:Markdown .