diff options
author | David Robillard <d@drobilla.net> | 2014-07-31 20:39:26 +0000 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2014-07-31 20:39:26 +0000 |
commit | 1c67d8123580b5cf70b5530277ad8320e97174cd (patch) | |
tree | 7b2382e550b35c6d87362f8995198f640fd5fdad /lv2/lv2plug.in/ns/lv2core | |
parent | 64e25ef4f27e9e82402ba1a361e8c443eefc93db (diff) | |
download | lv2-1c67d8123580b5cf70b5530277ad8320e97174cd.tar.xz |
Use Doxygen Markdown support for more human-readable doc comments.
Minor improvements to UI documentation.
Diffstat (limited to 'lv2/lv2plug.in/ns/lv2core')
-rw-r--r-- | lv2/lv2plug.in/ns/lv2core/lv2.h | 8 |
1 files changed, 4 insertions, 4 deletions
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 |