aboutsummaryrefslogtreecommitdiffstats
path: root/lv2/atom/util.h
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/atom/util.h
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/atom/util.h')
-rw-r--r--lv2/atom/util.h14
1 files changed, 10 insertions, 4 deletions
diff --git a/lv2/atom/util.h b/lv2/atom/util.h
index 051a3cb..383d304 100644
--- a/lv2/atom/util.h
+++ b/lv2/atom/util.h
@@ -114,7 +114,9 @@ lv2_atom_sequence_next(const LV2_Atom_Event* i)
@param seq The sequence to iterate over
@param iter The name of the iterator
- This macro is used similarly to a for loop (which it expands to), e.g.:
+ This macro is used similarly to a for loop (which it expands to), for
+ example:
+
@code
LV2_ATOM_SEQUENCE_FOREACH(sequence, ev) {
// Do something with ev (an LV2_Atom_Event*) here...
@@ -154,7 +156,7 @@ lv2_atom_sequence_clear(LV2_Atom_Sequence* seq)
@param seq Sequence to append to.
@param capacity Total capacity of the sequence atom
- (e.g. as set by the host for sequence output ports).
+ (as set by the host for sequence output ports).
@param event Event to write.
@return A pointer to the newly written event in `seq`,
@@ -211,7 +213,9 @@ lv2_atom_tuple_next(const LV2_Atom* i)
@param tuple The tuple to iterate over
@param iter The name of the iterator
- This macro is used similarly to a for loop (which it expands to), e.g.:
+ This macro is used similarly to a for loop (which it expands to), for
+ example:
+
@code
LV2_ATOM_TUPLE_FOREACH(tuple, elem) {
// Do something with elem (an LV2_Atom*) here...
@@ -267,7 +271,9 @@ lv2_atom_object_next(const LV2_Atom_Property_Body* i)
@param obj The object to iterate over
@param iter The name of the iterator
- This macro is used similarly to a for loop (which it expands to), e.g.:
+ This macro is used similarly to a for loop (which it expands to), for
+ example:
+
@code
LV2_ATOM_OBJECT_FOREACH(object, i) {
// Do something with i (an LV2_Atom_Property_Body*) here...