diff options
| author | David Robillard <d@drobilla.net> | 2011-02-12 00:36:14 +0000 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2011-02-12 00:36:14 +0000 |
| commit | e07eb06e7d29cc2ddee94e24571118d09c624e1e (patch) | |
| tree | 744f4e71db112d8eeb7b492ab38d41cbe8a9c6e3 /slv2/pluginuiinstance.h | |
| parent | 0b6bdcce6cea21909553a334629a5b3d004bd553 (diff) | |
| download | lilv-e07eb06e7d29cc2ddee94e24571118d09c624e1e.tar.gz lilv-e07eb06e7d29cc2ddee94e24571118d09c624e1e.tar.bz2 lilv-e07eb06e7d29cc2ddee94e24571118d09c624e1e.zip | |
Tidy up documentation, remove cruft.
git-svn-id: http://svn.drobilla.net/lad/trunk/slv2@2924 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'slv2/pluginuiinstance.h')
| -rw-r--r-- | slv2/pluginuiinstance.h | 15 |
1 files changed, 5 insertions, 10 deletions
diff --git a/slv2/pluginuiinstance.h b/slv2/pluginuiinstance.h index 503ce53..59bc16d 100644 --- a/slv2/pluginuiinstance.h +++ b/slv2/pluginuiinstance.h @@ -38,24 +38,23 @@ typedef struct _SLV2UIInstance { SLV2UIInstanceImpl pimpl; ///< Private implementation }* SLV2UIInstance; -/** \addtogroup slv2_library +/** @addtogroup slv2_library * @{ */ /** Instantiate a plugin UI. - * * The returned object represents shared library objects loaded into memory, * it must be cleaned up with slv2_ui_instance_free when no longer * needed. * - * \a plugin is not modified or directly referenced by the returned object + * @a plugin is not modified or directly referenced by the returned object * (instances store only a copy of the plugin's URI). * - * \a host_features NULL-terminated array of features the host supports. + * @a host_features NULL-terminated array of features the host supports. * NULL may be passed if the host supports no additional features (unlike * the LV2 specification - SLV2 takes care of it). * - * \return NULL if instantiation failed. + * @return NULL if instantiation failed. */ SLV2_API SLV2UIInstance @@ -66,12 +65,10 @@ slv2_ui_instantiate(SLV2Plugin plugin, const LV2_Feature* const* features); /** Free a plugin UI instance. - * + * @a instance is invalid after this call. * It is the caller's responsibility to ensure all references to the UI * instance (including any returned widgets) are cut before calling * this function. - * - * \a instance is invalid after this call. */ SLV2_API void @@ -84,7 +81,6 @@ LV2UI_Widget slv2_ui_instance_get_widget(SLV2UIInstance instance); /** Get the LV2UI_Descriptor of the plugin UI instance. - * * Normally hosts should not need to access the LV2UI_Descriptor directly, * use the slv2_ui_instance_* functions. * @@ -95,7 +91,6 @@ const LV2UI_Descriptor* slv2_ui_instance_get_descriptor(SLV2UIInstance instance); /** Get the LV2UI_Handle of the plugin UI instance. - * * Normally hosts should not need to access the LV2UI_Handle directly, * use the slv2_ui_instance_* functions. * |