aboutsummaryrefslogtreecommitdiffstats
path: root/lv2/core
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/core
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/core')
-rw-r--r--lv2/core/lv2.h15
-rw-r--r--lv2/core/lv2core.meta.ttl4
2 files changed, 9 insertions, 10 deletions
diff --git a/lv2/core/lv2.h b/lv2/core/lv2.h
index 57032fe..9b2de6f 100644
--- a/lv2/core/lv2.h
+++ b/lv2/core/lv2.h
@@ -193,9 +193,8 @@ typedef struct LV2_Descriptor {
@param sample_rate Sample rate, in Hz, for the new plugin instance.
@param bundle_path Path to the LV2 bundle which contains this plugin
- binary. It MUST include the trailing directory separator (e.g. '/') so
- that simply appending a filename will yield the path to that file in the
- bundle.
+ binary. It MUST include the trailing directory separator so that simply
+ appending a filename will yield the path to that file in the bundle.
@param features A NULL terminated array of LV2_Feature structs which
represent the features the host supports. Plugins may refuse to
@@ -243,7 +242,7 @@ typedef struct LV2_Descriptor {
it does, the plugin's behaviour is undefined (a crash is likely).
@param data_location Pointer to data of the type defined by the port
- type in the plugin's RDF data (e.g. an array of float for an
+ type in the plugin's RDF data (for example, an array of float for an
lv2:AudioPort). This pointer must be stored by the plugin instance and
used to read/write data when run() is called. Data present at the time
of the connect_port() call MUST NOT be considered meaningful.
@@ -287,10 +286,10 @@ typedef struct LV2_Descriptor {
lv2core.ttl for details).
As a special case, when `sample_count` is 0, the plugin should update
- any output ports that represent a single instant in time (e.g. control
- ports, but not audio ports). This is particularly useful for latent
- plugins, which should update their latency output port so hosts can
- pre-roll plugins to compute latency. Plugins MUST NOT crash when
+ any output ports that represent a single instant in time (for example,
+ control ports, but not audio ports). This is particularly useful for
+ latent plugins, which should update their latency output port so hosts
+ can pre-roll plugins to compute latency. Plugins MUST NOT crash when
`sample_count` is 0.
@param instance Instance to be run.
diff --git a/lv2/core/lv2core.meta.ttl b/lv2/core/lv2core.meta.ttl
index 45e1a5a..1826a06 100644
--- a/lv2/core/lv2core.meta.ttl
+++ b/lv2/core/lv2core.meta.ttl
@@ -465,7 +465,7 @@ number with the usual semantics:
plugin.
* The micro version is incremented for changes which do not affect
- compatibility at all, e.g. bug fixes or documentation updates.
+ compatibility at all, for example bug fixes or documentation updates.
Note that there is deliberately no major version: all versions with the same
URI are compatible by definition. Replacing a resource with a newer version of
@@ -670,7 +670,7 @@ lv2:control
This should be used as the lv2:designation of ports that are used to send
commands and receive responses. Typically this will be an event port that
-supports some protocol, e.g. MIDI or LV2 Atoms.
+supports some protocol, for example MIDI or LV2 Atoms.
"""^^lv2:Markdown .