diff options
Diffstat (limited to 'lv2/atom')
| -rw-r--r-- | lv2/atom/atom.h | 6 | ||||
| -rw-r--r-- | lv2/atom/util.h | 14 |
2 files changed, 13 insertions, 7 deletions
diff --git a/lv2/atom/atom.h b/lv2/atom/atom.h index d2c25ff..8c0f30a 100644 --- a/lv2/atom/atom.h +++ b/lv2/atom/atom.h @@ -80,7 +80,7 @@ typedef char lv2_atom_assert_double_fits_in_64_bits[ /** Return a pointer to the contents of an Atom. The "contents" of an atom is the data past the complete type-specific header. - @param type The type of the atom, e.g. LV2_Atom_String. + @param type The type of the atom, for example LV2_Atom_String. @param atom A variable-sized atom. */ #define LV2_ATOM_CONTENTS(type, atom) \ @@ -180,7 +180,7 @@ typedef struct { LV2_Atom_Vector_Body body; /**< Body. */ } LV2_Atom_Vector; -/** The body of an atom:Property (e.g. in an atom:Object). */ +/** The body of an atom:Property (typically in an atom:Object). */ typedef struct { uint32_t key; /**< Key (predicate) (mapped URI). */ uint32_t context; /**< Context URID (may be, and generally is, 0). */ @@ -226,7 +226,7 @@ typedef struct { LV2_Descriptor::run(), the default stamp type is audio frames. The contents of a sequence is a series of LV2_Atom_Event, each aligned - to 64-bits, e.g.: + to 64-bits, for example: <pre> | Event 1 (size 6) | Event 2 | | | | | | | | | 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... |