summaryrefslogtreecommitdiffstats
path: root/suil
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2011-03-17 20:10:25 +0000
committerDavid Robillard <d@drobilla.net>2011-03-17 20:10:25 +0000
commitc69ce36bea15426f4793f3247d37019f531e1f1f (patch)
treef3472f180489d4cd047a319c0e670cee319fa2bc /suil
parent2f06c910da4a3a57857f69b1b3e803c18e71deb3 (diff)
downloadsuil-c69ce36bea15426f4793f3247d37019f531e1f1f.tar.gz
suil-c69ce36bea15426f4793f3247d37019f531e1f1f.tar.bz2
suil-c69ce36bea15426f4793f3247d37019f531e1f1f.zip
Improve documentation.
git-svn-id: http://svn.drobilla.net/lad/trunk/suil@3111 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'suil')
-rw-r--r--suil/suil.h11
1 files changed, 7 insertions, 4 deletions
diff --git a/suil/suil.h b/suil/suil.h
index af556a6..02a37cd 100644
--- a/suil/suil.h
+++ b/suil/suil.h
@@ -24,7 +24,7 @@
*/
/**
- @file slv2.h API for Suil, an LV2 UI wrapper library.
+ @file suil.h API for Suil, an LV2 UI wrapper library.
*/
#ifndef SUIL_SUIL_H
@@ -78,10 +78,13 @@ suil_ui_type_supported(const char* host_type_uri,
/**
Instantiate a UI for an LV2 plugin.
- @param uis Set of available UIs for the plugin.
- @param type_uri URI of the desired widget type.
+ @param plugin_uri URI of the plugin to instantiate this UI for.
@param ui_uri URI of a specifically desired UI, or NULL to use the
best choice given @a type_uri.
+ @param ui_bundle_path Path of the UI bundle.
+ @param ui_binary_path Path of the UI binary.
+ @param ui_type_uri URI of the actual UI widget type.
+ @param host_type_uri URI of the desired widget type.
@param write_function Write function as defined by the LV2 UI extension.
@param controller Opaque controller to be passed to @a write_function.
@param features NULL-terminated array of supported features, or NULL.
@@ -162,4 +165,4 @@ suil_instance_extension_data(SuilInstance instance,
} /* extern "C" */
#endif
-#endif /* SUIL_SUIL_H__ */
+#endif /* SUIL_SUIL_H */