aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2012-07-08 06:46:51 +0000
committerDavid Robillard <d@drobilla.net>2012-07-08 06:46:51 +0000
commit89c3ba3ba719e67f996cd8d6bbdd23d82e3b482d (patch)
tree2404fdba567684a54f93da9ae2658475d9789996
parent9f325f2e52cfce78058555099c7874cd81f950df (diff)
downloadlv2-89c3ba3ba719e67f996cd8d6bbdd23d82e3b482d.tar.xz
Fix outdated documentation in forge.h.
-rw-r--r--lv2/lv2plug.in/ns/ext/atom/atom.ttl2
-rw-r--r--lv2/lv2plug.in/ns/ext/atom/forge.h12
2 files changed, 7 insertions, 7 deletions
diff --git a/lv2/lv2plug.in/ns/ext/atom/atom.ttl b/lv2/lv2plug.in/ns/ext/atom/atom.ttl
index ef37293..177d085 100644
--- a/lv2/lv2plug.in/ns/ext/atom/atom.ttl
+++ b/lv2/lv2plug.in/ns/ext/atom/atom.ttl
@@ -31,6 +31,8 @@
rdfs:label "Fix lv2_atom_object_next() on 32-bit platforms."
] , [
rdfs:label "Add lv2_atom_object_body_get()."
+ ] , [
+ rdfs:label "Fix outdated documentation in forge.h."
]
]
] , [
diff --git a/lv2/lv2plug.in/ns/ext/atom/forge.h b/lv2/lv2plug.in/ns/ext/atom/forge.h
index 7cc9b31..54ba25b 100644
--- a/lv2/lv2plug.in/ns/ext/atom/forge.h
+++ b/lv2/lv2plug.in/ns/ext/atom/forge.h
@@ -572,8 +572,6 @@ lv2_atom_forge_property_head(LV2_Atom_Forge* forge,
/**
Write the header for a Sequence.
- The size of the returned sequence will be 0, so passing it as the parent
- parameter to other forge methods will do the right thing.
*/
static inline LV2_Atom_Forge_Ref
lv2_atom_forge_sequence_head(LV2_Atom_Forge* forge,
@@ -590,8 +588,8 @@ lv2_atom_forge_sequence_head(LV2_Atom_Forge* forge,
/**
Write the time stamp header of an Event (in a Sequence) in audio frames.
- After this, call the appropriate forge method(s) to write the body, passing
- the same @p parent parameter. Note the returned LV2_Event is NOT an Atom.
+ After this, call the appropriate forge method(s) to write the body. Note
+ the returned reference is to an LV2_Event which is NOT an Atom.
*/
static inline LV2_Atom_Forge_Ref
lv2_atom_forge_frame_time(LV2_Atom_Forge* forge, int64_t frames)
@@ -600,9 +598,9 @@ lv2_atom_forge_frame_time(LV2_Atom_Forge* forge, int64_t frames)
}
/**
- Write the time stamp header of an Event (in a Sequence) in beats.
- After this, call the appropriate forge method(s) to write the body, passing
- the same @p parent parameter. Note the returned LV2_Event is NOT an Atom.
+ Write the time stamp header of an Event (in a Sequence) in beats. After
+ this, call the appropriate forge method(s) to write the body. Note the
+ returned reference is to an LV2_Event which is NOT an Atom.
*/
static inline LV2_Atom_Forge_Ref
lv2_atom_forge_beat_time(LV2_Atom_Forge* forge, double beats)