diff options
author | David Robillard <d@drobilla.net> | 2007-04-20 03:57:41 +0000 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2007-04-20 03:57:41 +0000 |
commit | be95afee123c169b083049c2f441d3860a12fea0 (patch) | |
tree | 78c907f1828bbe8a8521a83313e793c01a989903 /slv2/port.h | |
parent | c625507d8a3101742c083dd030cbd1e1e295a9a0 (diff) | |
download | lilv-be95afee123c169b083049c2f441d3860a12fea0.tar.gz lilv-be95afee123c169b083049c2f441d3860a12fea0.tar.bz2 lilv-be95afee123c169b083049c2f441d3860a12fea0.zip |
Clean up API, hide more methods that should not be exposed to user.
Document performance of most methods.
Clean up and clarify documentation.
git-svn-id: http://svn.drobilla.net/lad/slv2@460 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'slv2/port.h')
-rw-r--r-- | slv2/port.h | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/slv2/port.h b/slv2/port.h index 13ac5c1..d415f84 100644 --- a/slv2/port.h +++ b/slv2/port.h @@ -34,6 +34,8 @@ extern "C" { /** Port equivalent to slv2_plugin_get_value. + * + * Time = Query */ SLV2Strings slv2_port_get_value(SLV2Plugin plugin, @@ -42,6 +44,8 @@ slv2_port_get_value(SLV2Plugin plugin, /** Port equivalent to slv2_plugin_get_properties. + * + * Time = Query */ SLV2Strings slv2_port_get_properties(SLV2Plugin plugin, @@ -49,6 +53,8 @@ slv2_port_get_properties(SLV2Plugin plugin, /** Port equivalent to slv2_plugin_get_hints. + * + * Time = Query */ SLV2Strings slv2_port_get_hints(SLV2Plugin plugin, @@ -61,6 +67,8 @@ slv2_port_get_hints(SLV2Plugin plugin, * Returned string must be free()'d by caller. * * \return NULL when index is out of range + * + * Time = Query */ char* slv2_port_get_symbol(SLV2Plugin plugin, @@ -71,6 +79,8 @@ slv2_port_get_symbol(SLV2Plugin plugin, * This is guaranteed to return the untranslated name (the doap:name in the * data file without a language tag). Returned value must be free()'d by * the caller. + * + * Time = Query */ char* slv2_port_get_name(SLV2Plugin plugin, @@ -78,6 +88,8 @@ slv2_port_get_name(SLV2Plugin plugin, /** Get the class (input/output, data type, rate...) of a port. + * + * Time = Query */ SLV2PortClass slv2_port_get_class(SLV2Plugin plugin, @@ -87,6 +99,8 @@ slv2_port_get_class(SLV2Plugin plugin, /** Get the default value of a port. * * Only valid for ports with a data type of lv2:float. + * + * Time = Query */ float slv2_port_get_default_value(SLV2Plugin plugin, @@ -96,6 +110,8 @@ slv2_port_get_default_value(SLV2Plugin plugin, /** Get the minimum value of a port. * * Only valid for ports with a data type of lv2:float. + * + * Time = Query */ float slv2_port_get_minimum_value(SLV2Plugin plugin, @@ -105,6 +121,8 @@ slv2_port_get_minimum_value(SLV2Plugin plugin, /** Get the maximum value of a port. * * Only valid for ports with a data type of lv2:float. + * + * Time = Query */ float slv2_port_get_maximum_value(SLV2Plugin plugin, |