diff options
Diffstat (limited to 'lv2')
| -rw-r--r-- | lv2/lv2plug.in/ns/ext/event/event-helpers.h | 32 | ||||
| -rw-r--r-- | lv2/lv2plug.in/ns/ext/event/event.h | 4 | ||||
| -rw-r--r-- | lv2/lv2plug.in/ns/ext/resize-port/resize-port.h | 2 | ||||
| -rw-r--r-- | lv2/lv2plug.in/ns/ext/state/state.h | 6 | ||||
| -rw-r--r-- | lv2/lv2plug.in/ns/lv2core/lv2.h | 8 |
5 files changed, 26 insertions, 26 deletions
diff --git a/lv2/lv2plug.in/ns/ext/event/event-helpers.h b/lv2/lv2plug.in/ns/ext/event/event-helpers.h index b748395..06e02a7 100644 --- a/lv2/lv2plug.in/ns/ext/event/event-helpers.h +++ b/lv2/lv2plug.in/ns/ext/event/event-helpers.h @@ -1,5 +1,5 @@ /* - Copyright 2008-2012 David Robillard <http://drobilla.net> + Copyright 2008-2014 David Robillard <http://drobilla.net> Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above @@ -96,8 +96,8 @@ typedef struct { } LV2_Event_Iterator; -/** Reset an iterator to point to the start of @a buf. - * @return True if @a iter is valid, otherwise false (buffer is empty) */ +/** Reset an iterator to point to the start of `buf`. + * @return True if `iter` is valid, otherwise false (buffer is empty) */ static inline bool lv2_event_begin(LV2_Event_Iterator* iter, LV2_Event_Buffer* buf) @@ -108,8 +108,8 @@ lv2_event_begin(LV2_Event_Iterator* iter, } -/** Check if @a iter is valid. - * @return True if @a iter is valid, otherwise false (past end of buffer) */ +/** Check if `iter` is valid. + * @return True if `iter` is valid, otherwise false (past end of buffer) */ static inline bool lv2_event_is_valid(LV2_Event_Iterator* iter) { @@ -117,9 +117,9 @@ lv2_event_is_valid(LV2_Event_Iterator* iter) } -/** Advance @a iter forward one event. - * @a iter must be valid. - * @return True if @a iter is valid, otherwise false (reached end of buffer) */ +/** Advance `iter` forward one event. + * `iter` must be valid. + * @return True if `iter` is valid, otherwise false (reached end of buffer) */ static inline bool lv2_event_increment(LV2_Event_Iterator* iter) { @@ -138,11 +138,11 @@ lv2_event_increment(LV2_Event_Iterator* iter) /** Dereference an event iterator (get the event currently pointed at). - * @a iter must be valid. - * @a data if non-NULL, will be set to point to the contents of the event + * `iter` must be valid. + * `data` if non-NULL, will be set to point to the contents of the event * returned. - * @return A Pointer to the event @a iter is currently pointing at, or NULL - * if the end of the buffer is reached (in which case @a data is + * @return A Pointer to the event `iter` is currently pointing at, or NULL + * if the end of the buffer is reached (in which case `data` is * also set to NULL). */ static inline LV2_Event* lv2_event_get(LV2_Event_Iterator* iter, @@ -162,8 +162,8 @@ lv2_event_get(LV2_Event_Iterator* iter, } -/** Write an event at @a iter. - * The event (if any) pointed to by @a iter will be overwritten, and @a iter +/** Write an event at `iter`. + * The event (if any) pointed to by `iter` will be overwritten, and `iter` * incremented to point to the following event (i.e. several calls to this * function can be done in sequence without twiddling iter in-between). * @return True if event was written, otherwise false (buffer is full). */ @@ -230,8 +230,8 @@ lv2_event_reserve(LV2_Event_Iterator* iter, } -/** Write an event at @a iter. - * The event (if any) pointed to by @a iter will be overwritten, and @a iter +/** Write an event at `iter`. + * The event (if any) pointed to by `iter` will be overwritten, and `iter` * incremented to point to the following event (i.e. several calls to this * function can be done in sequence without twiddling iter in-between). * @return True if event was written, otherwise false (buffer is full). */ diff --git a/lv2/lv2plug.in/ns/ext/event/event.h b/lv2/lv2plug.in/ns/ext/event/event.h index e33d862..abc0b96 100644 --- a/lv2/lv2plug.in/ns/ext/event/event.h +++ b/lv2/lv2plug.in/ns/ext/event/event.h @@ -255,7 +255,7 @@ typedef struct { @param context The calling context. Like event types, this is a mapped URI, see lv2_context.h. Simple plugin with just a run() method should pass 0 here (the ID of the 'standard' LV2 run context). The host - guarantees that this function is realtime safe iff @a context is + guarantees that this function is realtime safe iff the context is realtime safe. PLUGINS THAT VIOLATE THESE RULES MAY CAUSE CRASHES AND MEMORY LEAKS. @@ -278,7 +278,7 @@ typedef struct { @param context The calling context. Like event types, this is a mapped URI, see lv2_context.h. Simple plugin with just a run() method should pass 0 here (the ID of the 'standard' LV2 run context). The host - guarantees that this function is realtime safe iff @a context is + guarantees that this function is realtime safe iff the context is realtime safe. PLUGINS THAT VIOLATE THESE RULES MAY CAUSE CRASHES AND MEMORY LEAKS. diff --git a/lv2/lv2plug.in/ns/ext/resize-port/resize-port.h b/lv2/lv2plug.in/ns/ext/resize-port/resize-port.h index fa3abd7..23bc578 100644 --- a/lv2/lv2plug.in/ns/ext/resize-port/resize-port.h +++ b/lv2/lv2plug.in/ns/ext/resize-port/resize-port.h @@ -46,7 +46,7 @@ typedef struct { LV2_Resize_Port_Feature_Data data; /** - Resize a port buffer to at least @a size bytes. + Resize a port buffer to at least `size` bytes. This function MAY return an error, in which case the port buffer was not resized and the port is still connected to the same location. Plugins diff --git a/lv2/lv2plug.in/ns/ext/state/state.h b/lv2/lv2plug.in/ns/ext/state/state.h index f701682..95e3dee 100644 --- a/lv2/lv2plug.in/ns/ext/state/state.h +++ b/lv2/lv2plug.in/ns/ext/state/state.h @@ -262,7 +262,7 @@ typedef struct _LV2_State_Interface { } LV2_State_Interface; /** - Feature data for state:mapPath (LV2_STATE__mapPath). + Feature data for state:mapPath (@ref LV2_STATE__mapPath). */ typedef struct { /** @@ -278,12 +278,12 @@ typedef struct { The plugin MUST use this function to map any paths that will be stored in plugin state. The returned value is an abstract path which MAY not - be an actual file system path; @ref absolute_path() MUST be used to map + be an actual file system path; absolute_path() MUST be used to map it to an actual path in order to use the file. Plugins MUST NOT make any assumptions about abstract paths except that they can be mapped back to the absolute path of the "same" file (though - not necessarily the same original path) using @ref absolute_path(). + not necessarily the same original path) using absolute_path(). This function may only be called within the context of LV2_State_Interface methods. The caller is responsible for freeing the diff --git a/lv2/lv2plug.in/ns/lv2core/lv2.h b/lv2/lv2plug.in/ns/lv2core/lv2.h index a7f9039..504ffd9 100644 --- a/lv2/lv2plug.in/ns/lv2core/lv2.h +++ b/lv2/lv2plug.in/ns/lv2core/lv2.h @@ -21,7 +21,7 @@ /** @file lv2.h API for the LV2 specification <http://lv2plug.in/ns/lv2core>. - Revision: 12.0 + Revision: 12.2 */ #ifndef LV2_H_INCLUDED @@ -135,7 +135,7 @@ typedef void * LV2_Handle; Features allow hosts to make additional functionality available to plugins without requiring modification to the LV2 API. Extensions may define new - features and specify the @ref URI and @ref data to be used if necessary. + features and specify the `URI` and `data` to be used if necessary. Some features, such as lv2:isLive, do not require the host to pass data. */ typedef struct _LV2_Feature { @@ -150,7 +150,7 @@ typedef struct _LV2_Feature { Pointer to arbitrary data. The format of this data is defined by the extension which describes the - feature with the given @ref URI. + feature with the given `URI`. */ void * data; } LV2_Feature; @@ -418,7 +418,7 @@ typedef struct { Plugins are accessed by index using values from 0 upwards. Out of range indices MUST result in this function returning NULL, so the host can - enumerate plugins by increasing @a index until NULL is returned. + enumerate plugins by increasing `index` until NULL is returned. */ const LV2_Descriptor * (*get_plugin)(LV2_Lib_Handle handle, uint32_t index); |