From 1c67d8123580b5cf70b5530277ad8320e97174cd Mon Sep 17 00:00:00 2001 From: David Robillard Date: Thu, 31 Jul 2014 20:39:26 +0000 Subject: Use Doxygen Markdown support for more human-readable doc comments. Minor improvements to UI documentation. --- lv2/lv2plug.in/ns/lv2core/lv2.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'lv2/lv2plug.in/ns/lv2core') diff --git a/lv2/lv2plug.in/ns/lv2core/lv2.h b/lv2/lv2plug.in/ns/lv2core/lv2.h index 6e0edaa..a7f9039 100644 --- a/lv2/lv2plug.in/ns/lv2core/lv2.h +++ b/lv2/lv2plug.in/ns/lv2core/lv2.h @@ -276,12 +276,12 @@ typedef struct _LV2_Descriptor { things that the plugin MUST NOT do within the run() function (see lv2core.ttl for details). - As a special case, when @p sample_count == 0, the plugin should update + As a special case, when `sample_count` is 0, the plugin should update any output ports that represent a single instant in time (e.g. control ports, but not audio ports). This is particularly useful for latent plugins, which should update their latency output port so hosts can pre-roll plugins to compute latency. Plugins MUST NOT crash when - @p sample_count == 0. + `sample_count` is 0. @param instance Instance to be run. @@ -368,9 +368,9 @@ typedef struct _LV2_Descriptor { function to find the LV2_Descriptor for the desired plugin. Plugins are accessed by index using values from 0 upwards. This function MUST return NULL for out of range indices, so the host can enumerate plugins by - increasing @p index until NULL is returned. + increasing `index` until NULL is returned. - Note that @p index has no meaning, hosts MUST NOT depend on it remaining + Note that `index` has no meaning, hosts MUST NOT depend on it remaining consistent between loads of the plugin library. */ LV2_SYMBOL_EXPORT -- cgit v1.2.1