aboutsummaryrefslogtreecommitdiffstats
path: root/lv2/lv2plug.in/ns/ext
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2014-11-25 00:23:48 -0500
committerDavid Robillard <d@drobilla.net>2014-11-25 00:23:48 -0500
commit68a4dc89f5e00aa6e2780f4f96011b92961b7a80 (patch)
tree22882da1f402bd6067415e687f9061c77680c198 /lv2/lv2plug.in/ns/ext
parent1754a6fe0866fcf84846722f45042caa698d1aea (diff)
downloadlv2-68a4dc89f5e00aa6e2780f4f96011b92961b7a80.tar.xz
Single-page API documentation with unified style.
Diffstat (limited to 'lv2/lv2plug.in/ns/ext')
-rw-r--r--lv2/lv2plug.in/ns/ext/atom/atom.h12
-rw-r--r--lv2/lv2plug.in/ns/ext/atom/atom.ttl45
-rw-r--r--lv2/lv2plug.in/ns/ext/atom/forge.h7
-rw-r--r--lv2/lv2plug.in/ns/ext/atom/util.h7
-rw-r--r--lv2/lv2plug.in/ns/ext/buf-size/buf-size.h13
-rw-r--r--lv2/lv2plug.in/ns/ext/buf-size/lv2-buf-size.doap.ttl2
-rw-r--r--lv2/lv2plug.in/ns/ext/data-access/data-access.h14
-rw-r--r--lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.h14
-rw-r--r--lv2/lv2plug.in/ns/ext/event/event.h22
-rw-r--r--lv2/lv2plug.in/ns/ext/instance-access/instance-access.h25
-rw-r--r--lv2/lv2plug.in/ns/ext/log/log.h12
-rw-r--r--lv2/lv2plug.in/ns/ext/log/logger.h19
-rw-r--r--lv2/lv2plug.in/ns/ext/midi/midi.h10
-rw-r--r--lv2/lv2plug.in/ns/ext/morph/lv2-morph.doap.ttl2
-rw-r--r--lv2/lv2plug.in/ns/ext/morph/morph.h13
-rw-r--r--lv2/lv2plug.in/ns/ext/options/options.h13
-rw-r--r--lv2/lv2plug.in/ns/ext/parameters/parameters.h13
-rw-r--r--lv2/lv2plug.in/ns/ext/patch/patch.h16
-rw-r--r--lv2/lv2plug.in/ns/ext/port-groups/port-groups.h13
-rw-r--r--lv2/lv2plug.in/ns/ext/port-props/port-props.h12
-rw-r--r--lv2/lv2plug.in/ns/ext/presets/lv2-presets.doap.ttl2
-rw-r--r--lv2/lv2plug.in/ns/ext/presets/presets.h11
-rw-r--r--lv2/lv2plug.in/ns/ext/resize-port/lv2-resize-port.doap.ttl2
-rw-r--r--lv2/lv2plug.in/ns/ext/resize-port/resize-port.h12
-rw-r--r--lv2/lv2plug.in/ns/ext/state/state.h12
-rw-r--r--lv2/lv2plug.in/ns/ext/time/time.h15
-rw-r--r--lv2/lv2plug.in/ns/ext/uri-map/uri-map.h11
-rw-r--r--lv2/lv2plug.in/ns/ext/urid/urid.h12
-rw-r--r--lv2/lv2plug.in/ns/ext/worker/worker.h24
29 files changed, 282 insertions, 103 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 */
+
+/**
+ @}
+*/
07' href='#n1907'>1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701