aboutsummaryrefslogtreecommitdiffstats
path: root/lv2
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2020-03-12 13:29:56 +0100
committerDavid Robillard <d@drobilla.net>2020-03-12 13:29:56 +0100
commit1d75523156c28b8a31b1a5d6504d78fe49b9cf62 (patch)
treea0029e9772884a07951f25240b757e0d77d40b97 /lv2
parentb4fc36f81f146d0140d4ce4040584f4a00f4f35c (diff)
downloadlv2-1d75523156c28b8a31b1a5d6504d78fe49b9cf62.tar.xz
Put all code documentation in an "lv2" group
This makes it feasible to merge the LV2 documentation into more broad documentation in a meta-project.
Diffstat (limited to 'lv2')
-rw-r--r--lv2/atom/atom.h1
-rw-r--r--lv2/buf-size/buf-size.h1
-rw-r--r--lv2/core/attributes.h1
-rw-r--r--lv2/core/lv2.h9
-rw-r--r--lv2/data-access/data-access.h1
-rw-r--r--lv2/dynmanifest/dynmanifest.h1
-rw-r--r--lv2/event/event.h1
-rw-r--r--lv2/instance-access/instance-access.h1
-rw-r--r--lv2/log/log.h1
-rw-r--r--lv2/midi/midi.h1
-rw-r--r--lv2/morph/morph.h1
-rw-r--r--lv2/options/options.h1
-rw-r--r--lv2/parameters/parameters.h1
-rw-r--r--lv2/patch/patch.h1
-rw-r--r--lv2/port-groups/port-groups.h1
-rw-r--r--lv2/port-props/port-props.h1
-rw-r--r--lv2/presets/presets.h1
-rw-r--r--lv2/resize-port/resize-port.h1
-rw-r--r--lv2/state/state.h1
-rw-r--r--lv2/time/time.h1
-rw-r--r--lv2/ui/ui.h1
-rw-r--r--lv2/units/units.h1
-rw-r--r--lv2/uri-map/uri-map.h1
-rw-r--r--lv2/urid/urid.h1
-rw-r--r--lv2/worker/worker.h1
25 files changed, 33 insertions, 0 deletions
diff --git a/lv2/atom/atom.h b/lv2/atom/atom.h
index dd332ce..d2c25ff 100644
--- a/lv2/atom/atom.h
+++ b/lv2/atom/atom.h
@@ -16,6 +16,7 @@
/**
@defgroup atom Atom
+ @ingroup lv2
A generic value container and several data types, see
<http://lv2plug.in/ns/ext/atom> for details.
diff --git a/lv2/buf-size/buf-size.h b/lv2/buf-size/buf-size.h
index 900f8fa..7655c77 100644
--- a/lv2/buf-size/buf-size.h
+++ b/lv2/buf-size/buf-size.h
@@ -19,6 +19,7 @@
/**
@defgroup buf-size Buffer Size
+ @ingroup lv2
Access to, and restrictions on, buffer sizes; see
<http://lv2plug.in/ns/ext/buf-size> for details.
diff --git a/lv2/core/attributes.h b/lv2/core/attributes.h
index c054ae1..7465c22 100644
--- a/lv2/core/attributes.h
+++ b/lv2/core/attributes.h
@@ -19,6 +19,7 @@
/**
@defgroup attributes Attributes
+ @ingroup lv2
Macros for source code attributes.
diff --git a/lv2/core/lv2.h b/lv2/core/lv2.h
index 77d58ee..57032fe 100644
--- a/lv2/core/lv2.h
+++ b/lv2/core/lv2.h
@@ -19,6 +19,14 @@
*/
/**
+ @defgroup lv2 LV2
+
+ The LV2 specification.
+
+ @{
+*/
+
+/**
@defgroup lv2core LV2 Core
Core LV2 specification, see <http://lv2plug.in/ns/lv2core> for details.
@@ -471,4 +479,5 @@ typedef const LV2_Lib_Descriptor *
/**
@}
+ @}
*/
diff --git a/lv2/data-access/data-access.h b/lv2/data-access/data-access.h
index 8f98834..f57b1e2 100644
--- a/lv2/data-access/data-access.h
+++ b/lv2/data-access/data-access.h
@@ -17,6 +17,7 @@
/**
@defgroup data-access Data Access
+ @ingroup lv2
Access to plugin extension_data() for UIs, see
<http://lv2plug.in/ns/ext/data-access> for details.
diff --git a/lv2/dynmanifest/dynmanifest.h b/lv2/dynmanifest/dynmanifest.h
index 289a96f..0feda89 100644
--- a/lv2/dynmanifest/dynmanifest.h
+++ b/lv2/dynmanifest/dynmanifest.h
@@ -17,6 +17,7 @@
/**
@defgroup dynmanifest Dynamic Manifest
+ @ingroup lv2
Support for dynamic data generation, see
<http://lv2plug.in/ns/ext/dynmanifest> for details.
diff --git a/lv2/event/event.h b/lv2/event/event.h
index 70cae6a..30d73a6 100644
--- a/lv2/event/event.h
+++ b/lv2/event/event.h
@@ -17,6 +17,7 @@
/**
@defgroup event Event
+ @ingroup lv2
Generic time-stamped events, see <http://lv2plug.in/ns/ext/event> for
details.
diff --git a/lv2/instance-access/instance-access.h b/lv2/instance-access/instance-access.h
index 7e328fd..6a58541 100644
--- a/lv2/instance-access/instance-access.h
+++ b/lv2/instance-access/instance-access.h
@@ -17,6 +17,7 @@
/**
@defgroup instance-access Instance Access
+ @ingroup lv2
Access to the LV2_Handle of a plugin for UIs; see
<http://lv2plug.in/ns/ext/instance-access> for details.
diff --git a/lv2/log/log.h b/lv2/log/log.h
index d60ebb4..8930fac 100644
--- a/lv2/log/log.h
+++ b/lv2/log/log.h
@@ -16,6 +16,7 @@
/**
@defgroup log Log
+ @ingroup lv2
Interface for plugins to log via the host; see
<http://lv2plug.in/ns/ext/log> for details.
diff --git a/lv2/midi/midi.h b/lv2/midi/midi.h
index 52e9956..0abfba1 100644
--- a/lv2/midi/midi.h
+++ b/lv2/midi/midi.h
@@ -16,6 +16,7 @@
/**
@defgroup midi MIDI
+ @ingroup lv2
Definitions of standard MIDI messages, see <http://lv2plug.in/ns/ext/midi>
for details.
diff --git a/lv2/morph/morph.h b/lv2/morph/morph.h
index 884af74..101df8e 100644
--- a/lv2/morph/morph.h
+++ b/lv2/morph/morph.h
@@ -16,6 +16,7 @@
/**
@defgroup morph Morph
+ @ingroup lv2
Ports that can dynamically change type, see <http://lv2plug.in/ns/ext/morph>
for details.
diff --git a/lv2/options/options.h b/lv2/options/options.h
index 6d7fe77..2ed9f8a 100644
--- a/lv2/options/options.h
+++ b/lv2/options/options.h
@@ -16,6 +16,7 @@
/**
@defgroup options Options
+ @ingroup lv2
Instantiation time options, see <http://lv2plug.in/ns/ext/options> for
details.
diff --git a/lv2/parameters/parameters.h b/lv2/parameters/parameters.h
index f81e78b..01c6dde 100644
--- a/lv2/parameters/parameters.h
+++ b/lv2/parameters/parameters.h
@@ -16,6 +16,7 @@
/**
@defgroup parameters Parameters
+ @ingroup lv2
Common parameters for audio processing, see
<http://lv2plug.in/ns/ext/parameters>.
diff --git a/lv2/patch/patch.h b/lv2/patch/patch.h
index fed6a87..a721c5e 100644
--- a/lv2/patch/patch.h
+++ b/lv2/patch/patch.h
@@ -16,6 +16,7 @@
/**
@defgroup patch Patch
+ @ingroup lv2
Messages for accessing and manipulating properties, see
<http://lv2plug.in/ns/ext/patch> for details.
diff --git a/lv2/port-groups/port-groups.h b/lv2/port-groups/port-groups.h
index a1bcd12..4c5699f 100644
--- a/lv2/port-groups/port-groups.h
+++ b/lv2/port-groups/port-groups.h
@@ -16,6 +16,7 @@
/**
@defgroup port-groups Port Groups
+ @ingroup lv2
Multi-channel groups of LV2 ports, see
<http://lv2plug.in/ns/ext/port-groups> for details.
diff --git a/lv2/port-props/port-props.h b/lv2/port-props/port-props.h
index ef2b64d..eb55130 100644
--- a/lv2/port-props/port-props.h
+++ b/lv2/port-props/port-props.h
@@ -16,6 +16,7 @@
/**
@defgroup port-props Port Properties
+ @ingroup lv2
Various port properties.
diff --git a/lv2/presets/presets.h b/lv2/presets/presets.h
index 7c51b1c..8264a9c 100644
--- a/lv2/presets/presets.h
+++ b/lv2/presets/presets.h
@@ -16,6 +16,7 @@
/**
@defgroup presets Presets
+ @ingroup lv2
Presets for plugins, see <http://lv2plug.in/ns/ext/presets> for details.
diff --git a/lv2/resize-port/resize-port.h b/lv2/resize-port/resize-port.h
index 08f82f1..a60626d 100644
--- a/lv2/resize-port/resize-port.h
+++ b/lv2/resize-port/resize-port.h
@@ -16,6 +16,7 @@
/**
@defgroup resize-port Resize Port
+ @ingroup lv2
Dynamically sized LV2 port buffers.
diff --git a/lv2/state/state.h b/lv2/state/state.h
index 365711a..cea4037 100644
--- a/lv2/state/state.h
+++ b/lv2/state/state.h
@@ -17,6 +17,7 @@
/**
@defgroup state State
+ @ingroup lv2
An interface for LV2 plugins to save and restore state, see
<http://lv2plug.in/ns/ext/state> for details.
diff --git a/lv2/time/time.h b/lv2/time/time.h
index ec5007c..912d732 100644
--- a/lv2/time/time.h
+++ b/lv2/time/time.h
@@ -16,6 +16,7 @@
/**
@defgroup time Time
+ @ingroup lv2
Properties for describing time, see <http://lv2plug.in/ns/ext/time> for
details.
diff --git a/lv2/ui/ui.h b/lv2/ui/ui.h
index 0852050..8e67a36 100644
--- a/lv2/ui/ui.h
+++ b/lv2/ui/ui.h
@@ -18,6 +18,7 @@
/**
@defgroup ui User Interfaces
+ @ingroup lv2
User interfaces of any type for plugins,
<http://lv2plug.in/ns/extensions/ui> for details.
diff --git a/lv2/units/units.h b/lv2/units/units.h
index a0885da..caea38d 100644
--- a/lv2/units/units.h
+++ b/lv2/units/units.h
@@ -16,6 +16,7 @@
/**
@defgroup units Units
+ @ingroup lv2
Units for LV2 values, see <http://lv2plug.in/ns/extensions/units> for
details.
diff --git a/lv2/uri-map/uri-map.h b/lv2/uri-map/uri-map.h
index 7bd2724..651c3a8 100644
--- a/lv2/uri-map/uri-map.h
+++ b/lv2/uri-map/uri-map.h
@@ -16,6 +16,7 @@
/**
@defgroup uri-map URI Map
+ @ingroup lv2
C API for the LV2 URI Map extension <http://lv2plug.in/ns/ext/uri-map>.
diff --git a/lv2/urid/urid.h b/lv2/urid/urid.h
index c74aaed..a68bc12 100644
--- a/lv2/urid/urid.h
+++ b/lv2/urid/urid.h
@@ -17,6 +17,7 @@
/**
@defgroup urid URID
+ @ingroup lv2
Features for mapping URIs to and from integers, see
<http://lv2plug.in/ns/ext/urid> for details.
diff --git a/lv2/worker/worker.h b/lv2/worker/worker.h
index 2c25425..35b82b5 100644
--- a/lv2/worker/worker.h
+++ b/lv2/worker/worker.h
@@ -16,6 +16,7 @@
/**
@defgroup worker Worker
+ @ingroup lv2
Support for non-realtime plugin operations, see
<http://lv2plug.in/ns/ext/worker> for details.