diff options
Diffstat (limited to 'lv2')
34 files changed, 327 insertions, 124 deletions
diff --git a/lv2/lv2plug.in/ns/ext/atom/atom.h b/lv2/lv2plug.in/ns/ext/atom/atom.h index 3f0195b..55fffe2 100644 --- a/lv2/lv2plug.in/ns/ext/atom/atom.h +++ b/lv2/lv2plug.in/ns/ext/atom/atom.h @@ -15,8 +15,12 @@ */ /** - @file atom.h C header for the LV2 Atom extension - <http://lv2plug.in/ns/ext/atom>. + @defgroup atom Atom + + A generic value container and several data types, see + <http://lv2plug.in/ns/ext/atom> for details. + + @{ */ #ifndef LV2_ATOM_H @@ -239,6 +243,10 @@ typedef struct { LV2_Atom_Sequence_Body body; /**< Body. */ } LV2_Atom_Sequence; +/** + @} +*/ + #ifdef __cplusplus } /* extern "C" */ #endif diff --git a/lv2/lv2plug.in/ns/ext/atom/atom.ttl b/lv2/lv2plug.in/ns/ext/atom/atom.ttl index 301f416..113cfe8 100644 --- a/lv2/lv2plug.in/ns/ext/atom/atom.ttl +++ b/lv2/lv2plug.in/ns/ext/atom/atom.ttl @@ -14,31 +14,26 @@ <forge.h> , <lv2-atom.doap.ttl> ; lv2:documentation """ -<p>This specification defines a simple generic data container, called an -<q>Atom</q>. An atom:Atom can contain simple primitive types like integers, + +<p>An #Atom is a simple generic data container for holding any type of Plain +Old Data (POD). An #Atom can contain simple primitive types like integers, floating point numbers, and strings; as well as structured data like lists and -dictionary-like <q>Objects</q>. An Atom is, with one exception, Plain Old Data -(POD), meaning it can be easily copied (e.g. using <code>memcpy</code>) and is -suitable for use in real-time code.</p> - -<p>Atoms are not limited to the types defined here, but allow implementations -to work with any type of POD data at all. This is possible because Atom types -are URIs, but mapped to integers using the <a href="../urid/urid.html">LV2 -URID</a> extension for performance reasons.</p> - -<p>Since atoms are simple to copy, -communication of any atom is simple to implement without requiring special code -for every type of data. For example, plugins that mutually understand a type -can be used together in a host that does not understand that type, because the -host is only required to copy atoms, not interpret their contents. Similarly, -plugins (such as routers, delays, or data structures) can meaningfully process -atoms of a type unknown to them.</p> - -<p>Atoms can and should be used anywhere values of various types must be stored -or transmitted. The port type atom:AtomPort can be used to transmit atoms via -ports. An atom:AtomPort that contains an atom:Sequence can be used for sample -accurate event communication, such as MIDI, and replaces the earlier <a -href="../event/event.html">LV2 event</a> extension.</p> +dictionary-like <q>Objects</q>. Since Atoms are POD, they can be easily copied +(e.g. using <code>memcpy</code>) anywhere and are suitable for use in real-time +code.</p> + +<p>Every atom starts with an LV2_Atom header, followed by the contents. This +allows code to process atoms without requiring special code for every type of +data. For example, plugins that mutually understand a type can be used +together in a host that does not understand that type, because the host is only +required to copy atoms, not interpret their contents. Similarly, plugins (such +as routers, delays, or data structures) can meaningfully process atoms of a +type unknown to them.</p> + +<p>Atoms should be used anywhere values of various types must be stored or +transmitted. The port type #AtomPort can be used to transmit atoms via ports. +An #AtomPort that contains an #Sequence can be used for sample accurate event +communication, such as MIDI, and replaces the earlier event extension.</p> <h3>Serialisation</h3> @@ -54,7 +49,7 @@ in plugin data files.</p> <p>While it is possible to define new Atom types for any binary format, the standard types defined here are powerful enough to describe almost anything. Implementations SHOULD build structures out of the types provided here, rather -than define new binary formats (e.g. use atom:Tuple or atom:Object rather than +than define new binary formats (e.g. use #Tuple or #Object rather than a new C <code>struct</code> type). Current implementations have support for serialising all standard types, so new binary formats are an implementation burden which harms interoperabilty. In particular, plugins SHOULD NOT expect diff --git a/lv2/lv2plug.in/ns/ext/atom/forge.h b/lv2/lv2plug.in/ns/ext/atom/forge.h index 3492712..0ce05dc 100644 --- a/lv2/lv2plug.in/ns/ext/atom/forge.h +++ b/lv2/lv2plug.in/ns/ext/atom/forge.h @@ -39,6 +39,12 @@ This header is non-normative, it is provided for convenience. */ +/** + @defgroup forge Forge + @ingroup atom + @{ +*/ + #ifndef LV2_ATOM_FORGE_H #define LV2_ATOM_FORGE_H @@ -687,6 +693,7 @@ lv2_atom_forge_beat_time(LV2_Atom_Forge* forge, double beats) /** @} + @} */ #if defined(__clang__) diff --git a/lv2/lv2plug.in/ns/ext/atom/util.h b/lv2/lv2plug.in/ns/ext/atom/util.h index 1340024..52cdf93 100644 --- a/lv2/lv2plug.in/ns/ext/atom/util.h +++ b/lv2/lv2plug.in/ns/ext/atom/util.h @@ -22,6 +22,12 @@ This header is non-normative, it is provided for convenience. */ +/** + @defgroup util Utilities + @ingroup atom + @{ +*/ + #ifndef LV2_ATOM_UTIL_H #define LV2_ATOM_UTIL_H @@ -437,6 +443,7 @@ lv2_atom_object_get(const LV2_Atom_Object* object, ...) /** @} + @} */ #ifdef __cplusplus diff --git a/lv2/lv2plug.in/ns/ext/buf-size/buf-size.h b/lv2/lv2plug.in/ns/ext/buf-size/buf-size.h index 20cd8fd..105995b 100644 --- a/lv2/lv2plug.in/ns/ext/buf-size/buf-size.h +++ b/lv2/lv2plug.in/ns/ext/buf-size/buf-size.h @@ -17,6 +17,15 @@ #ifndef LV2_BUF_SIZE_H #define LV2_BUF_SIZE_H +/** + @defgroup buf-size Buffer Size + + Access to, and restrictions on, buffer sizes; see + <http://lv2plug.in/ns/ext/buf-size> for details. + + @{ +*/ + #define LV2_BUF_SIZE_URI "http://lv2plug.in/ns/ext/buf-size" #define LV2_BUF_SIZE_PREFIX LV2_BUF_SIZE_URI "#" @@ -27,4 +36,8 @@ #define LV2_BUF_SIZE__powerOf2BlockLength LV2_BUF_SIZE_PREFIX "powerOf2BlockLength" #define LV2_BUF_SIZE__sequenceSize LV2_BUF_SIZE_PREFIX "sequenceSize" +/** + @} +*/ + #endif /* LV2_BUF_SIZE_H */ diff --git a/lv2/lv2plug.in/ns/ext/buf-size/lv2-buf-size.doap.ttl b/lv2/lv2plug.in/ns/ext/buf-size/lv2-buf-size.doap.ttl index a57ebbd..a153480 100644 --- a/lv2/lv2plug.in/ns/ext/buf-size/lv2-buf-size.doap.ttl +++ b/lv2/lv2plug.in/ns/ext/buf-size/lv2-buf-size.doap.ttl @@ -6,7 +6,7 @@ <http://lv2plug.in/ns/ext/buf-size> a doap:Project ; rdfs:seeAlso <../../meta/meta.ttl> ; - doap:name "LV2 Buf Size Extension" ; + doap:name "LV2 Buf Size" ; doap:shortdesc "Access to, and restrictions on, buffer sizes." ; doap:created "2012-08-07" ; doap:developer <http://drobilla.net/drobilla#me> ; diff --git a/lv2/lv2plug.in/ns/ext/data-access/data-access.h b/lv2/lv2plug.in/ns/ext/data-access/data-access.h index 68aaf62..ab9262c 100644 --- a/lv2/lv2plug.in/ns/ext/data-access/data-access.h +++ b/lv2/lv2plug.in/ns/ext/data-access/data-access.h @@ -16,12 +16,12 @@ */ /** - @file data-access.h - C header for the LV2 Extension Data extension - <http://lv2plug.in/ns/ext/data-access>. + @defgroup data-access Data Access - This extension defines a method for (e.g.) plugin UIs to have (possibly - marshalled) access to the extension_data function on a plugin instance. + Access to plugin extension_data() for UIs, see + <http://lv2plug.in/ns/ext/data-acess> for details. + + @{ */ #ifndef LV2_DATA_ACCESS_H @@ -61,3 +61,7 @@ typedef struct { #endif #endif /* LV2_DATA_ACCESS_H */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.h b/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.h index b62f8ef..a85e332 100644 --- a/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.h +++ b/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.h @@ -16,10 +16,12 @@ */ /** - @file dynmanifest.h - C header for the LV2 Dynamic Manifest extension - <http://lv2plug.in/ns/ext/dynmanifest>. - Revision: 1.2 + @defgroup dynmanifest Dynamic Manifest + + Support for dynamic data generation, see + <http://lv2plug.in/ns/ext/dynmanifest> for details. + + @{ */ #ifndef LV2_DYN_MANIFEST_H_INCLUDED @@ -142,3 +144,7 @@ void lv2_dyn_manifest_close(LV2_Dyn_Manifest_Handle handle); #endif #endif /* LV2_DYN_MANIFEST_H_INCLUDED */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/ext/event/event.h b/lv2/lv2plug.in/ns/ext/event/event.h index abc0b96..260dae1 100644 --- a/lv2/lv2plug.in/ns/ext/event/event.h +++ b/lv2/lv2plug.in/ns/ext/event/event.h @@ -16,18 +16,12 @@ */ /** - @file event.h - C API for the LV2 Event extension <http://lv2plug.in/ns/ext/event>. - - This extension is a generic transport mechanism for time stamped events - of any type (e.g. MIDI, OSC, ramps, etc). Each port can transport mixed - events of any type; the type of events and timestamps are defined by a URI - which is mapped to an integer by the host for performance reasons. - - This extension requires the host to support the LV2 URI Map extension. - Any host which supports this extension MUST guarantee that any call to - the LV2 URI Map uri_to_id function with the URI of this extension as the - 'map' argument returns a value within the range of uint16_t. + @defgroup event Event + + Generic time-stamped events, see <http://lv2plug.in/ns/ext/event> for + details. + + @{ */ #ifndef LV2_EVENT_H @@ -292,3 +286,7 @@ typedef struct { #endif #endif /* LV2_EVENT_H */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/ext/instance-access/instance-access.h b/lv2/lv2plug.in/ns/ext/instance-access/instance-access.h index 06d8dde..cc84d65 100644 --- a/lv2/lv2plug.in/ns/ext/instance-access/instance-access.h +++ b/lv2/lv2plug.in/ns/ext/instance-access/instance-access.h @@ -15,23 +15,22 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +/** + @defgroup instance-access Instance Access + + Access to the LV2_Handle of a plugin for UIs; see + <http://lv2plug.in/ns/ext/instance-access> for details. + + @{ +*/ + #ifndef LV2_INSTANCE_ACCESS_H #define LV2_INSTANCE_ACCESS_H #define LV2_INSTANCE_ACCESS_URI "http://lv2plug.in/ns/ext/instance-access" -/** - @file instance-access.h - C header for the LV2 Instance Access extension - <http://lv2plug.in/ns/ext/instance-access>. - - This extension defines a method for (e.g.) plugin UIs to get a direct - handle to an LV2 plugin instance (LV2_Handle), if possible. - - To support this feature the host must pass an LV2_Feature struct to the - UI instantiate method with URI "http://lv2plug.in/ns/ext/instance-access" - and data pointed directly to the LV2_Handle of the plugin instance. -*/ - #endif /* LV2_INSTANCE_ACCESS_H */ +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/ext/log/log.h b/lv2/lv2plug.in/ns/ext/log/log.h index d27e549..5245010 100644 --- a/lv2/lv2plug.in/ns/ext/log/log.h +++ b/lv2/lv2plug.in/ns/ext/log/log.h @@ -15,8 +15,12 @@ */ /** - @file log.h C header for the LV2 Log extension - <http://lv2plug.in/ns/ext/log>. + @defgroup log Log + + Interface for plugins to log via the host; see + <http://lv2plug.in/ns/ext/log> for details. + + @{ */ #ifndef LV2_LOG_H @@ -97,3 +101,7 @@ typedef struct _LV2_Log { #endif #endif /* LV2_LOG_H */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/ext/log/logger.h b/lv2/lv2plug.in/ns/ext/log/logger.h index 1b03866..094dd42 100644 --- a/lv2/lv2plug.in/ns/ext/log/logger.h +++ b/lv2/lv2plug.in/ns/ext/log/logger.h @@ -15,13 +15,14 @@ */ /** - @file logger.h Convenience API for easy logging in plugin code. + @defgroup logger Logger + @ingroup log - This file provides simple wrappers for the most common log operations for - use in plugin implementations. If host support for logging is not - available, then these functions will print to stderr instead. + Convenience API for easy logging in plugin code. This API provides simple + wrappers for logging from a plugin, which automatically fall back to + printing to stderr if host support is unavailabe. - This header is non-normative, it is provided for convenience. + @{ */ #ifndef LV2_ATOM_LOGGER_H @@ -135,12 +136,12 @@ lv2_log_warning(LV2_Log_Logger* logger, const char* fmt, ...) return ret; } -/** - @} -*/ - #ifdef __cplusplus } /* extern "C" */ #endif #endif /* LV2_LOG_LOGGER_H */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/ext/midi/midi.h b/lv2/lv2plug.in/ns/ext/midi/midi.h index b45b4c2..3c8d23e 100644 --- a/lv2/lv2plug.in/ns/ext/midi/midi.h +++ b/lv2/lv2plug.in/ns/ext/midi/midi.h @@ -15,8 +15,10 @@ */ /** - @file midi.h - C definitions for the LV2 MIDI extension <http://lv2plug.in/ns/ext/midi>. + @defgroup midi MIDI + + Definitions of standard MIDI messages, see <http://lv2plug.in/ns/ext/midi> + for details. */ #ifndef LV2_MIDI_H @@ -224,3 +226,7 @@ lv2_midi_message_type(const uint8_t* msg) { #endif #endif /* LV2_MIDI_H */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/ext/morph/lv2-morph.doap.ttl b/lv2/lv2plug.in/ns/ext/morph/lv2-morph.doap.ttl index 73abdc2..3c7a542 100644 --- a/lv2/lv2plug.in/ns/ext/morph/lv2-morph.doap.ttl +++ b/lv2/lv2plug.in/ns/ext/morph/lv2-morph.doap.ttl @@ -6,7 +6,7 @@ <http://lv2plug.in/ns/ext/morph> a doap:Project ; rdfs:seeAlso <../../meta/meta.ttl> ; - doap:name "LV2 Morph Extension" ; + doap:name "LV2 Morph" ; doap:shortdesc "Ports that can dynamically change type." ; doap:created "2012-05-22" ; doap:developer <http://drobilla.net/drobilla#me> ; diff --git a/lv2/lv2plug.in/ns/ext/morph/morph.h b/lv2/lv2plug.in/ns/ext/morph/morph.h index 6739d39..f16f334 100644 --- a/lv2/lv2plug.in/ns/ext/morph/morph.h +++ b/lv2/lv2plug.in/ns/ext/morph/morph.h @@ -14,6 +14,15 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +/** + @defgroup morph Morph + + Ports that can dynamically change type, see <http://lv2plug.in/ns/ext/morph> + for details. + + @{ +*/ + #ifndef LV2_MORPH_H #define LV2_MORPH_H @@ -32,3 +41,7 @@ #define LV2_MORPH__currentType LV2_MORPH_PREFIX "currentType" #endif /* LV2_MORPH_H */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/ext/options/options.h b/lv2/lv2plug.in/ns/ext/options/options.h index 1a71a3e..a74126b 100644 --- a/lv2/lv2plug.in/ns/ext/options/options.h +++ b/lv2/lv2plug.in/ns/ext/options/options.h @@ -14,6 +14,15 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +/** + @defgroup options Options + + Instantiation time options, see <http://lv2plug.in/ns/ext/options> for + details. + + @{ +*/ + #ifndef LV2_OPTIONS_H #define LV2_OPTIONS_H @@ -130,3 +139,7 @@ typedef struct _LV2_Options_Interface { #endif #endif /* LV2_OPTIONS_H */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/ext/parameters/parameters.h b/lv2/lv2plug.in/ns/ext/parameters/parameters.h index 9c06bab..70235b7 100644 --- a/lv2/lv2plug.in/ns/ext/parameters/parameters.h +++ b/lv2/lv2plug.in/ns/ext/parameters/parameters.h @@ -14,6 +14,15 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +/** + @defgroup parameters Parameters + + Common parameters for audio processing, see + <http://lv2plug.in/ns/ext/parameters>. + + @{ +*/ + #ifndef LV2_PARAMETERS_H #define LV2_PARAMETERS_H @@ -47,3 +56,7 @@ #define LV2_PARAMETERS__wetLevel LV2_PARAMETERS_PREFIX "wetLevel" #endif /* LV2_PARAMETERS_H */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/ext/patch/patch.h b/lv2/lv2plug.in/ns/ext/patch/patch.h index 3224264..57a495a 100644 --- a/lv2/lv2plug.in/ns/ext/patch/patch.h +++ b/lv2/lv2plug.in/ns/ext/patch/patch.h @@ -15,11 +15,15 @@ */ /** - @file patch.h C header for the LV2 Patch extension - <http://lv2plug.in/ns/ext/patch>. + @defgroup patch Patch - The patch extension is purely data, this header merely defines URIs - for convenience. + Messages for accessing and manipulating properties, see + <http://lv2plug.in/ns/ext/patch> for details. + + Note the patch extension is purely data, this header merely defines URIs for + convenience. + + @{ */ #ifndef LV2_PATCH_H @@ -54,3 +58,7 @@ #define LV2_PATCH__writable LV2_PATCH_PREFIX "writable" #endif /* LV2_PATCH_H */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/ext/port-groups/port-groups.h b/lv2/lv2plug.in/ns/ext/port-groups/port-groups.h index 4dd8cf4..6e80294 100644 --- a/lv2/lv2plug.in/ns/ext/port-groups/port-groups.h +++ b/lv2/lv2plug.in/ns/ext/port-groups/port-groups.h @@ -15,9 +15,12 @@ */ /** - @file port-groups.h - C definitions for the LV2 Port Groups extension - <http://lv2plug.in/ns/ext/port-groups>. + @defgroup port-groups Port Groups + + Multi-channel groups of LV2 ports, see + <http://lv2plug.in/ns/ext/port-groups> for details. + + @{ */ #ifndef LV2_PORT_GROUPS_H @@ -62,3 +65,7 @@ #define LV2_PORT_GROUPS__subGroupOf LV2_PORT_GROUPS_PREFIX "subGroupOf" #endif /* LV2_PORT_GROUPS_H */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/ext/port-props/port-props.h b/lv2/lv2plug.in/ns/ext/port-props/port-props.h index 11274cc..32e110a 100644 --- a/lv2/lv2plug.in/ns/ext/port-props/port-props.h +++ b/lv2/lv2plug.in/ns/ext/port-props/port-props.h @@ -15,9 +15,11 @@ */ /** - @file port-props.h - C definitions for the LV2 Port Props extension - <http://lv2plug.in/ns/ext/port-props>. + @defgroup port-props Port Properties + + Various port properties. + + @{ */ #ifndef LV2_PORT_PROPS_H @@ -40,3 +42,7 @@ #define LV2_PORT_PROPS__trigger LV2_PORT_PROPS_PREFIX "trigger" #endif /* LV2_PORT_PROPS_H */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/ext/presets/lv2-presets.doap.ttl b/lv2/lv2plug.in/ns/ext/presets/lv2-presets.doap.ttl index e5bca3a..990972b 100644 --- a/lv2/lv2plug.in/ns/ext/presets/lv2-presets.doap.ttl +++ b/lv2/lv2plug.in/ns/ext/presets/lv2-presets.doap.ttl @@ -8,7 +8,7 @@ rdfs:seeAlso <../../meta/meta.ttl> ; doap:license <http://opensource.org/licenses/isc> ; doap:name "LV2 Presets" ; - doap:shortdesc "Presets for LV2 plugins. " ; + doap:shortdesc "Presets for LV2 plugins." ; doap:created "2009-00-00" ; doap:developer <http://drobilla.net/drobilla#me> ; doap:release [ diff --git a/lv2/lv2plug.in/ns/ext/presets/presets.h b/lv2/lv2plug.in/ns/ext/presets/presets.h index 4851feb..22d91a6 100644 --- a/lv2/lv2plug.in/ns/ext/presets/presets.h +++ b/lv2/lv2plug.in/ns/ext/presets/presets.h @@ -15,10 +15,11 @@ */ /** - @file presets.h + @defgroup presets Presets - C definitions for the LV2 Presets extension - <http://lv2plug.in/ns/ext/presets>. + Presets for plugins, see <http://lv2plug.in/ns/ext/presets> for details. + + @{ */ #ifndef LV2_PRESETS_H @@ -32,3 +33,7 @@ #define LV2_PRESETS__value LV2_PRESETS_PREFIX "value" #endif /* LV2_PRESETS_H */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/ext/resize-port/lv2-resize-port.doap.ttl b/lv2/lv2plug.in/ns/ext/resize-port/lv2-resize-port.doap.ttl index 7617a2c..644b1ce 100644 --- a/lv2/lv2plug.in/ns/ext/resize-port/lv2-resize-port.doap.ttl +++ b/lv2/lv2plug.in/ns/ext/resize-port/lv2-resize-port.doap.ttl @@ -6,7 +6,7 @@ <http://lv2plug.in/ns/ext/resize-port> a doap:Project ; rdfs:seeAlso <../../meta/meta.ttl> ; - doap:name "LV2 Resize Port Extension" ; + doap:name "LV2 Resize Port" ; doap:shortdesc "Dynamically sized LV2 port buffers." ; doap:created "2007-00-00" ; doap:developer <http://drobilla.net/drobilla#me> ; 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 23bc578..3d883a8 100644 --- a/lv2/lv2plug.in/ns/ext/resize-port/resize-port.h +++ b/lv2/lv2plug.in/ns/ext/resize-port/resize-port.h @@ -14,6 +14,14 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +/** + @defgroup resize-port Resize Port + + Dynamically sized LV2 port buffers. + + @{ +*/ + #ifndef LV2_RESIZE_PORT_H #define LV2_RESIZE_PORT_H @@ -42,6 +50,7 @@ typedef enum { typedef void* LV2_Resize_Port_Feature_Data; +/** Host feature to allow plugins to resize their port buffers. */ typedef struct { LV2_Resize_Port_Feature_Data data; @@ -70,3 +79,6 @@ typedef struct { #endif /* LV2_RESIZE_PORT_H */ +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/ext/state/state.h b/lv2/lv2plug.in/ns/ext/state/state.h index 95e3dee..1b08852 100644 --- a/lv2/lv2plug.in/ns/ext/state/state.h +++ b/lv2/lv2plug.in/ns/ext/state/state.h @@ -16,8 +16,12 @@ */ /** - @file state.h - C API for the LV2 State extension <http://lv2plug.in/ns/ext/state>. + @defgroup state State + + An interface for LV2 plugins to save and restore state, see + <http://lv2plug.in/ns/ext/state> for details. + + @{ */ #ifndef LV2_STATE_H @@ -350,3 +354,7 @@ typedef struct { #endif #endif /* LV2_STATE_H */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/ext/time/time.h b/lv2/lv2plug.in/ns/ext/time/time.h index 4f2bea0..14c930b 100644 --- a/lv2/lv2plug.in/ns/ext/time/time.h +++ b/lv2/lv2plug.in/ns/ext/time/time.h @@ -15,8 +15,15 @@ */ /** - @file time.h C header for the LV2 Time extension - <http://lv2plug.in/ns/ext/time>. + @defgroup time Time + + Properties for describing time, see <http://lv2plug.in/ns/ext/time> for + details. + + Note the time extension is purely data, this header merely defines URIs for + convenience. + + @{ */ #ifndef LV2_TIME_H @@ -38,4 +45,8 @@ #define LV2_TIME__framesPerSecond LV2_TIME_URI "#framesPerSecond" #define LV2_TIME__speed LV2_TIME_URI "#speed" +/** + @} +*/ + #endif /* LV2_TIME_H */ diff --git a/lv2/lv2plug.in/ns/ext/uri-map/uri-map.h b/lv2/lv2plug.in/ns/ext/uri-map/uri-map.h index 2062af3..dd03345 100644 --- a/lv2/lv2plug.in/ns/ext/uri-map/uri-map.h +++ b/lv2/lv2plug.in/ns/ext/uri-map/uri-map.h @@ -15,8 +15,9 @@ */ /** - @file - C header for the LV2 URI Map extension <http://lv2plug.in/ns/ext/uri-map>. + @defgroup uri-map URI Map + + C API for the LV2 URI Map extension <http://lv2plug.in/ns/ext/uri-map>. This extension defines a simple mechanism for plugins to map URIs to integers, usually for performance reasons (e.g. processing events typed by @@ -25,6 +26,8 @@ values for use in the audio thread without doing any string comparison. This allows the extensibility of RDF with the performance of integers (or centrally defined enumerations). + + @{ */ #ifndef LV2_URI_MAP_H @@ -96,3 +99,7 @@ typedef struct { #endif #endif /* LV2_URI_MAP_H */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/ext/urid/urid.h b/lv2/lv2plug.in/ns/ext/urid/urid.h index 5a308c5..ae1f113 100644 --- a/lv2/lv2plug.in/ns/ext/urid/urid.h +++ b/lv2/lv2plug.in/ns/ext/urid/urid.h @@ -16,8 +16,12 @@ */ /** - @file urid.h - C header for the LV2 URID extension <http://lv2plug.in/ns/ext/urid> + @defgroup urid URID + + Features for mapping URIs to and from integers, see + <http://lv2plug.in/ns/ext/urid> for details. + + @{ */ #ifndef LV2_URID_H @@ -127,3 +131,7 @@ typedef struct _LV2_URID_Unmap { #endif #endif /* LV2_URID_H */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/ext/worker/worker.h b/lv2/lv2plug.in/ns/ext/worker/worker.h index 6c9386b..c14397d 100644 --- a/lv2/lv2plug.in/ns/ext/worker/worker.h +++ b/lv2/lv2plug.in/ns/ext/worker/worker.h @@ -15,8 +15,12 @@ */ /** - @file worker.h C header for the LV2 Worker extension - <http://lv2plug.in/ns/ext/worker>. + @defgroup worker Worker + + Support for non-realtime plugin operations, see + <http://lv2plug.in/ns/ext/worker> for details. + + @{ */ #ifndef LV2_WORKER_H @@ -37,7 +41,7 @@ extern "C" { #endif /** - A status code for worker functions. + Status code for worker functions. */ typedef enum { LV2_WORKER_SUCCESS = 0, /**< Completed successfully. */ @@ -45,6 +49,7 @@ typedef enum { LV2_WORKER_ERR_NO_SPACE = 2 /**< Failed due to lack of space. */ } LV2_Worker_Status; +/** Opaque handle for LV2_Worker_Interface::work(). */ typedef void* LV2_Worker_Respond_Handle; /** @@ -60,7 +65,7 @@ typedef LV2_Worker_Status (*LV2_Worker_Respond_Function)( const void* data); /** - LV2 Plugin Worker Interface. + Plugin Worker Interface. This is the interface provided by the plugin to implement a worker method. The plugin's extension_data() method should return an LV2_Worker_Interface @@ -112,8 +117,15 @@ typedef struct _LV2_Worker_Interface { LV2_Worker_Status (*end_run)(LV2_Handle instance); } LV2_Worker_Interface; +/** Opaque handle for LV2_Worker_Schedule. */ typedef void* LV2_Worker_Schedule_Handle; +/** + Schedule Worker Host Feature. + + The host passes this feature to provide a schedule_work() function, which + the plugin can use to schedule a worker call from run(). +*/ typedef struct _LV2_Worker_Schedule { /** Opaque host data. @@ -156,3 +168,7 @@ typedef struct _LV2_Worker_Schedule { #endif #endif /* LV2_WORKER_H */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/extensions/ui/ui.h b/lv2/lv2plug.in/ns/extensions/ui/ui.h index 8fada66..27350c4 100644 --- a/lv2/lv2plug.in/ns/extensions/ui/ui.h +++ b/lv2/lv2plug.in/ns/extensions/ui/ui.h @@ -17,9 +17,12 @@ */ /** - @file ui.h User Interface API. + @defgroup ui User Interfaces - For high-level documentation, see <http://lv2plug.in/ns/extensions/ui>. + User interfaces of any type for plugins, + <http://lv2plug.in/ns/extensions/ui> for details. + + @{ */ #ifndef LV2_UI_H @@ -431,3 +434,7 @@ typedef const LV2UI_Descriptor* (*LV2UI_DescriptorFunction)(uint32_t index); #endif #endif /* LV2_UI_H */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/extensions/units/units.h b/lv2/lv2plug.in/ns/extensions/units/units.h index a40f097..e61af2a 100644 --- a/lv2/lv2plug.in/ns/extensions/units/units.h +++ b/lv2/lv2plug.in/ns/extensions/units/units.h @@ -15,9 +15,12 @@ */ /** - @file units.h - C definitions for the LV2 Units extension - <http://lv2plug.in/ns/extensions/units>. + @defgroup units Units + + Units for LV2 values, see <http://lv2plug.in/ns/extensions/units> for + details. + + @{ */ #ifndef LV2_UNITS_H @@ -60,3 +63,7 @@ #define LV2_UNITS__unit LV2_UNITS_PREFIX "unit" #endif /* LV2_UNITS_H */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/index.html.in b/lv2/lv2plug.in/ns/index.html.in index fc6ac2c..f093e3a 100644 --- a/lv2/lv2plug.in/ns/index.html.in +++ b/lv2/lv2plug.in/ns/index.html.in @@ -40,24 +40,26 @@ <!-- DESCRIPTION --> <!-- <h2 class="sec" id="sec-description">Description</h2> --> <div class="content"> - <p>This is an index of all official LV2 specifications. These pages are - high-level descriptions of each specification, and vocabulary - references with API links where appropriate. A - global <a href="../doc/html/index.html">API reference</a> is also - available.</p> + <p>All official LV2 specifications.</p> </div> <!-- INDEX --> - <h2 class="sec" id="sec-index">Index</h2> + <!-- <h2 class="sec" id="sec-index">Index</h2> --> <div class="content"> - <table summary="An index of LV2 specifications"> - <tr> - <th>Name</th> - <th>Description</th> - <th>Version</th> - <th>Status</th> - </tr> + <a id="sec-index" /> + <table class="index" summary="An index of LV2 specifications"> + <thead> + <tr> + <th>Specification</th> + <th>API</th> + <th>Description</th> + <th>Version</th> + <th>Status</th> + </tr> + </thead> + <tbody> @ROWS@ + </tbody> </table> </div> diff --git a/lv2/lv2plug.in/ns/lv2core/lv2.h b/lv2/lv2plug.in/ns/lv2core/lv2.h index 504ffd9..b2688c4 100644 --- a/lv2/lv2plug.in/ns/lv2core/lv2.h +++ b/lv2/lv2plug.in/ns/lv2core/lv2.h @@ -19,9 +19,11 @@ */ /** - @file lv2.h - API for the LV2 specification <http://lv2plug.in/ns/lv2core>. - Revision: 12.2 + @defgroup lv2core LV2 Core + + Core LV2 specification, see <http://lv2plug.in/ns/lv2core> for details. + + @{ */ #ifndef LV2_H_INCLUDED @@ -456,3 +458,7 @@ typedef const LV2_Lib_Descriptor * #endif #endif /* LV2_H_INCLUDED */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/meta/meta.ttl b/lv2/lv2plug.in/ns/meta/meta.ttl index aab2456..c072231 100644 --- a/lv2/lv2plug.in/ns/meta/meta.ttl +++ b/lv2/lv2plug.in/ns/meta/meta.ttl @@ -58,6 +58,8 @@ THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH R rdfs:label "eg-sampler: Add gain parameter." ] , [ rdfs:label "Fix merging of version histories in specification documentation." + ] , [ + rdfs:label "Improve API documentation." ] ] ] , [ |