From eb0f335d49ac3b501626d9e1ec140978fe795df6 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Thu, 7 Jan 2021 15:25:36 +0100 Subject: Generate documentation with Sphinx and add an overview --- doc/c/uis.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 doc/c/uis.rst (limited to 'doc/c/uis.rst') diff --git a/doc/c/uis.rst b/doc/c/uis.rst new file mode 100644 index 0000000..cbca8f6 --- /dev/null +++ b/doc/c/uis.rst @@ -0,0 +1,21 @@ +.. default-domain:: c +.. highlight:: c + +############### +User Interfaces +############### + +Plugins may have custom user interfaces, or `UIs`, +which are installed in bundles just like plugins. + +The available UIs for a plugin can be accessed with :func:`lilv_plugin_get_uis`: + +.. code-block:: c + + LilvUIs* uis = lilv_plugin_get_uis(plugin); + +:struct:`LilvUIs` is a collection much like `LilvPlugins`, +except it is of course a set of :struct:`LilvUI` rather than a set of :struct:`LilvPlugin`. +Also like plugins, +the :struct:`LilvUI` class has various accessors that can be used to get information about the UI. +See the :doc:`API reference ` for details. -- cgit v1.2.1