summaryrefslogtreecommitdiffstats
path: root/slv2/plugins.h
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2008-01-28 04:58:33 +0000
committerDavid Robillard <d@drobilla.net>2008-01-28 04:58:33 +0000
commit55b699d9a9b08ba8086f30f29348bf4c87231c12 (patch)
tree9b34dcadd5dced6bd41a0d1b80f47a5564a4a591 /slv2/plugins.h
parentf6dfbc3553f683b2f310892581c8707b1354edc7 (diff)
downloadlilv-55b699d9a9b08ba8086f30f29348bf4c87231c12.tar.gz
lilv-55b699d9a9b08ba8086f30f29348bf4c87231c12.tar.bz2
lilv-55b699d9a9b08ba8086f30f29348bf4c87231c12.zip
Documentation fixes.
git-svn-id: http://svn.drobilla.net/lad/slv2@1118 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'slv2/plugins.h')
-rw-r--r--slv2/plugins.h30
1 files changed, 15 insertions, 15 deletions
diff --git a/slv2/plugins.h b/slv2/plugins.h
index 3290c4f..6457af8 100644
--- a/slv2/plugins.h
+++ b/slv2/plugins.h
@@ -31,41 +31,41 @@ extern "C" {
*/
-/** Free a plugin list.
+/** Free a plugin plugins.
*
- * Freeing a plugin list does not destroy the plugins it contains (plugins
- * are owned by the world). \a list is invalid after this call.
+ * Freeing a plugin collection does not destroy the plugins it contains
+ * (plugins are owned by the world). \a plugins is invalid after this call.
*/
void
slv2_plugins_free(SLV2World world,
- SLV2Plugins list);
+ SLV2Plugins plugins);
-/** Get the number of plugins in the list.
+/** Get the number of plugins in the collection.
*/
unsigned
-slv2_plugins_size(SLV2Plugins list);
+slv2_plugins_size(SLV2Plugins plugins);
-/** Get a plugin from the list by URI.
+/** Get a plugin from the collection by URI.
*
- * Return value is shared (stored in \a list) and must not be freed or
+ * Return value is shared (stored in \a plugins) and must not be freed or
* modified by the caller in any way.
*
* Time = O(log2(n))
*
- * \return NULL if plugin with \a url not found in \a list.
+ * \return NULL if plugin with \a url not found in \a plugins.
*/
SLV2Plugin
-slv2_plugins_get_by_uri(SLV2Plugins list,
+slv2_plugins_get_by_uri(SLV2Plugins plugins,
SLV2Value uri);
-/** Get a plugin from the list by index.
+/** Get a plugin from the plugins by index.
*
- * \a index has no significance other than as an index into this list.
- * Any \a index not less than slv2_list_get_length(list) will return NULL,
- * so all plugins in a list can be enumerated by repeated calls
+ * \a index has no significance other than as an index into this plugins.
+ * Any \a index not less than slv2_plugins_get_length(plugins) will return NULL,
+ * so all plugins in a plugins can be enumerated by repeated calls
* to this function starting with \a index = 0.
*
* Time = O(1)
@@ -73,7 +73,7 @@ slv2_plugins_get_by_uri(SLV2Plugins list,
* \return NULL if \a index out of range.
*/
SLV2Plugin
-slv2_plugins_get_at(SLV2Plugins list,
+slv2_plugins_get_at(SLV2Plugins plugins,
unsigned index);