summaryrefslogtreecommitdiffstats
path: root/slv2
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2006-09-03 03:24:32 +0000
committerDavid Robillard <d@drobilla.net>2006-09-03 03:24:32 +0000
commit133415ab52c297199acb29822fc7ec572fbafa2f (patch)
tree6d684bddede123e2808287aad82c559126ab54df /slv2
parent69e52cb83cf0233648695730c81cdc4f7c4f2a00 (diff)
downloadlilv-133415ab52c297199acb29822fc7ec572fbafa2f.tar.gz
lilv-133415ab52c297199acb29822fc7ec572fbafa2f.tar.bz2
lilv-133415ab52c297199acb29822fc7ec572fbafa2f.zip
Warning and documentation fixes.
git-svn-id: http://svn.drobilla.net/lad/libslv2@111 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'slv2')
-rw-r--r--slv2/plugin.h2
-rw-r--r--slv2/pluginlist.h16
2 files changed, 8 insertions, 10 deletions
diff --git a/slv2/plugin.h b/slv2/plugin.h
index 2b2a295..57fa266 100644
--- a/slv2/plugin.h
+++ b/slv2/plugin.h
@@ -63,7 +63,7 @@ slv2_plugin_verify(const SLV2Plugin* plugin);
* Use this if you want to keep an SLV2Plugin around but free the list it came
* from.
*
- * \return a newly allocated SLV2Plugin identical to \a plugin (a deep copy).
+ * \return a newly allocated deep copy of \a plugin.
*/
SLV2Plugin*
slv2_plugin_duplicate(const SLV2Plugin* plugin);
diff --git a/slv2/pluginlist.h b/slv2/pluginlist.h
index 198ced8..7a0f967 100644
--- a/slv2/pluginlist.h
+++ b/slv2/pluginlist.h
@@ -77,8 +77,8 @@ slv2_list_free(SLV2List list);
* like to be visible in apps (or conversely a blacklist of plugins they do
* not wish to use).
*
- * Use of any of the other functions for locating plugins is highly
- * discouraged without specific reason to do so. Use this one.
+ * Use of any functions for locating plugins other than this one is \em highly
+ * discouraged without a special reason to do so - use this one.
*/
void
slv2_list_load_all(SLV2List list);
@@ -88,9 +88,7 @@ slv2_list_load_all(SLV2List list);
*
* If \a search_path is NULL, \a list will be unmodified.
*
- * Use of this function is not recommended. Use \ref slv2_list_load_all.
- *
- * Returned value must be cleaned up by slv2list_free.
+ * Use of this function is \b not recommended. Use \ref slv2_list_load_all.
*/
void
slv2_list_load_path(SLV2List list,
@@ -102,12 +100,12 @@ slv2_list_load_path(SLV2List list,
* \arg bundle_base_url is a fully qualified path to the bundle directory, eg.
* "file:///usr/lib/lv2/someBundle"
*
- * Use of this function is <b>strongly</b> discouraged, hosts should not attach
- * any significance to bundle paths as there are no guarantees they will
+ * Use of this function is \b strongly discouraged - hosts should not attach
+ * \em any significance to bundle paths as there are no guarantees they will
* remain consistent whatsoever. This function should only be used by apps
* which ship with a special bundle (which it knows exists at some path).
- * It is <b>not</b> to be used by normal hosts that want to load system
- * installed plugins. Use \ref slv2_list_load_all.
+ * It is \b not to be used by normal hosts that want to load system
+ * installed plugins. Use \ref slv2_list_load_all for that.
*/
void
slv2_list_load_bundle(SLV2List list,