diff options
| -rw-r--r-- | lv2/lv2plug.in/ns/ext/atom/util.h | 2 | ||||
| -rw-r--r-- | lv2/lv2plug.in/ns/ext/urid/urid.h | 4 | ||||
| -rw-r--r-- | lv2/lv2plug.in/ns/extensions/ui/ui.h | 20 | ||||
| -rw-r--r-- | lv2/lv2plug.in/ns/lv2core/lv2.h | 8 |
4 files changed, 17 insertions, 17 deletions
diff --git a/lv2/lv2plug.in/ns/ext/atom/util.h b/lv2/lv2plug.in/ns/ext/atom/util.h index f7fd35f..f07956b 100644 --- a/lv2/lv2plug.in/ns/ext/atom/util.h +++ b/lv2/lv2plug.in/ns/ext/atom/util.h @@ -212,7 +212,7 @@ lv2_atom_object_next(const LV2_Atom_Property_Body* i) /** A macro for iterating over all properties of an Object. - @param object The object to iterate over + @param obj The object to iterate over @param iter The name of the iterator This macro is used similarly to a for loop (which it expands to), e.g.: diff --git a/lv2/lv2plug.in/ns/ext/urid/urid.h b/lv2/lv2plug.in/ns/ext/urid/urid.h index edf047f..5947631 100644 --- a/lv2/lv2plug.in/ns/ext/urid/urid.h +++ b/lv2/lv2plug.in/ns/ext/urid/urid.h @@ -102,11 +102,11 @@ typedef struct { /** Get the URI for a previously mapped numeric ID. - Returns NULL if @c urid is not yet mapped. Otherwise, the corresponding + Returns NULL if @p urid is not yet mapped. Otherwise, the corresponding URI is returned in a canonical form. This MAY not be the exact same string that was originally passed to LV2_URID_Map::map(), but it MUST be an identical URI according to the URI syntax specification (RFC3986). A - non-NULL return for a given @c urid will always be the same for the life + non-NULL return for a given @p urid will always be the same for the life of the plugin. Plugins that intend to perform string comparison on unmapped URIs SHOULD first canonicalise URI strings with a call to map_uri() followed by a call to unmap_uri(). diff --git a/lv2/lv2plug.in/ns/extensions/ui/ui.h b/lv2/lv2plug.in/ns/extensions/ui/ui.h index 7526a5a..43d0307 100644 --- a/lv2/lv2plug.in/ns/extensions/ui/ui.h +++ b/lv2/lv2plug.in/ns/extensions/ui/ui.h @@ -93,12 +93,12 @@ typedef void* LV2UI_Feature_Handle; The type of the host-provided function that the UI can use to send data to a plugin's input ports. - The @c buffer parameter must point to a block of data, @c buffer_size bytes + The @p buffer parameter must point to a block of data, @c buffer_size bytes large. The format of this data and how the host should use it is defined by - the @c port_protocol. This buffer is owned by the UI and is only valid for + the @p port_protocol. This buffer is owned by the UI and is only valid for the duration of this call. - The @c port_protocol parameter should either be 0 or the URID for a + The @p port_protocol parameter should either be 0 or the URID for a ui:PortProtocol. If it is 0, the protocol is implicitly ui:floatProtocol, the port must be an lv2:ControlPort input, @c buffer must point to a single float value, and @c buffer_size must be sizeof(float). @@ -140,7 +140,7 @@ typedef struct _LV2UI_Descriptor { to send data to the plugin's input ports. @param controller A handle for the plugin instance that should be passed - as the first parameter of @c write_function. + as the first parameter of @p write_function. @param widget A pointer to an LV2UI_Widget. The UI will write a widget pointer to this location (what type of widget depends on the RDF class of @@ -173,19 +173,19 @@ typedef struct _LV2UI_Descriptor { Tell the UI that something interesting has happened at a plugin port. What is interesting and how it is written to the buffer passed to this - function is defined by the @c format parameter, which has the same + function is defined by the @p format parameter, which has the same meaning as in LV2UI_Write_Function. The only exception is ports of the class lv2:ControlPort, for which this function should be called when the port value changes (it does not have to be called for every single change if the host's UI thread has problems keeping up with the thread the - plugin is running in), @c buffer_size should be 4, the buffer should - contain a single IEEE-754 float, and @c format should be 0. + plugin is running in), @p buffer_size should be 4, the buffer should + contain a single IEEE-754 float, and @p format should be 0. By default, the host should only call this function for input ports of the lv2:ControlPort class. However, this can be modified by using ui:portNotification in the UI data, or the ui:portSubscribe feature. - The @c buffer is only valid during the time of this function call, so if + The @p buffer is only valid during the time of this function call, so if the UI wants to keep it for later use it has to copy the contents to an internal buffer. @@ -275,7 +275,7 @@ typedef struct _LV2UI_Port_Subscribe { This means that the host will call the UI's port_event() function when the port value changes (as defined by protocol). - Calling this function with the same @c port_index and @c port_protocol + Calling this function with the same @p port_index and @p port_protocol as an already active subscription has no effect. @param handle The handle field of this struct. @@ -295,7 +295,7 @@ typedef struct _LV2UI_Port_Subscribe { This means that the host will cease calling calling port_event() when the port value changes. - Calling this function with a @c port_index and @c port_protocol that + Calling this function with a @p port_index and @p port_protocol that does not refer to an active port subscription has no effect. @param handle The handle field of this struct. diff --git a/lv2/lv2plug.in/ns/lv2core/lv2.h b/lv2/lv2plug.in/ns/lv2core/lv2.h index 0b04bce..0a89491 100644 --- a/lv2/lv2plug.in/ns/lv2core/lv2.h +++ b/lv2/lv2plug.in/ns/lv2core/lv2.h @@ -272,12 +272,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 @c sample_count == 0, the plugin should update + As a special case, when @p sample_count == 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 - @c sample_count == 0. + @p sample_count == 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 @c index until NULL is returned. + increasing @p index until NULL is returned. - Note that @c index has no meaning, hosts MUST NOT depend on it remaining + Note that @p index has no meaning, hosts MUST NOT depend on it remaining consistent between loads of the plugin library. */ LV2_SYMBOL_EXPORT |