summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2012-01-18 17:28:56 +0000
committerDavid Robillard <d@drobilla.net>2012-01-18 17:28:56 +0000
commit886eaec350f143cfb3a97aa6f79b79bd5263c44a (patch)
treea16e25d5de4323fd2c57a69a02622eac6fb48b53
parent77daab8fea3dad68cc43ba087d3b8d4053a4e8ce (diff)
downloadlilv-886eaec350f143cfb3a97aa6f79b79bd5263c44a.tar.gz
lilv-886eaec350f143cfb3a97aa6f79b79bd5263c44a.tar.bz2
lilv-886eaec350f143cfb3a97aa6f79b79bd5263c44a.zip
Clarify documentation.
git-svn-id: http://svn.drobilla.net/lad/trunk/lilv@3964 a436a847-0d15-0410-975c-d299462d15a1
-rw-r--r--lilv/lilv.h5
1 files changed, 2 insertions, 3 deletions
diff --git a/lilv/lilv.h b/lilv/lilv.h
index 1d3bcd4..f16b5a4 100644
--- a/lilv/lilv.h
+++ b/lilv/lilv.h
@@ -1155,9 +1155,8 @@ typedef LilvNode* (*LilvGetPortValueFunc)(const char* port_symbol,
If supported (via state:makePath passed to LV2_Descriptor::instantiate()),
@c dir should be the directory where any plugin-created files are stored.
Lilv will assume any files within this directory (recursively) are created
- by the plugin and all other files are immutable. This function creates a
- new LilvState, but does not save state to disk. To save the state
- permanently, use lilv_state_save().
+ by the plugin and all other files are immutable. Note that this function
+ does not save the state, use lilv_state_save() for that.
See <a href="http://lv2plug.in/ns/ext/state/state.h">state.h</a> from the
LV2 State extension for details on the @c flags and @c features parameters.