diff options
author | David Robillard <d@drobilla.net> | 2020-11-17 11:11:05 +0100 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2020-11-17 11:11:05 +0100 |
commit | 3e7abdc3da504cff2d4c14a593ad140e6fb71764 (patch) | |
tree | 5d14a5aa019612fb7b2071c22f69b0c9d73927ef | |
parent | 5a9d1dbbddb24343208a3872ae4baaca4402b3bd (diff) | |
download | lv2-3e7abdc3da504cff2d4c14a593ad140e6fb71764.tar.xz |
Clean up Doxygen index
-rw-r--r-- | doc/doxy-style.css | 1 | ||||
-rw-r--r-- | lv2/atom/atom.h | 5 | ||||
-rw-r--r-- | lv2/atom/forge.h | 3 | ||||
-rw-r--r-- | lv2/atom/util.h | 3 | ||||
-rw-r--r-- | lv2/buf-size/buf-size.h | 5 | ||||
-rw-r--r-- | lv2/core/lv2.h | 4 | ||||
-rw-r--r-- | lv2/data-access/data-access.h | 5 | ||||
-rw-r--r-- | lv2/dynmanifest/dynmanifest.h | 5 | ||||
-rw-r--r-- | lv2/event/event.h | 5 | ||||
-rw-r--r-- | lv2/instance-access/instance-access.h | 5 | ||||
-rw-r--r-- | lv2/log/log.h | 5 | ||||
-rw-r--r-- | lv2/midi/midi.h | 5 | ||||
-rw-r--r-- | lv2/morph/morph.h | 5 | ||||
-rw-r--r-- | lv2/options/options.h | 5 | ||||
-rw-r--r-- | lv2/parameters/parameters.h | 5 | ||||
-rw-r--r-- | lv2/patch/patch.h | 5 | ||||
-rw-r--r-- | lv2/port-groups/port-groups.h | 5 | ||||
-rw-r--r-- | lv2/presets/presets.h | 4 | ||||
-rw-r--r-- | lv2/state/state.h | 5 | ||||
-rw-r--r-- | lv2/time/time.h | 5 | ||||
-rw-r--r-- | lv2/ui/ui.h | 5 | ||||
-rw-r--r-- | lv2/units/units.h | 5 | ||||
-rw-r--r-- | lv2/uri-map/uri-map.h | 4 | ||||
-rw-r--r-- | lv2/urid/urid.h | 5 | ||||
-rw-r--r-- | lv2/worker/worker.h | 5 |
25 files changed, 73 insertions, 41 deletions
diff --git a/doc/doxy-style.css b/doc/doxy-style.css index df8fcea..219da02 100644 --- a/doc/doxy-style.css +++ b/doc/doxy-style.css @@ -641,6 +641,7 @@ td.entry { width: 16px; height: 22px; vertical-align: top; + visibility: hidden; } td.entry b { diff --git a/lv2/atom/atom.h b/lv2/atom/atom.h index 8c0f30a..06b9943 100644 --- a/lv2/atom/atom.h +++ b/lv2/atom/atom.h @@ -18,8 +18,9 @@ @defgroup atom Atom @ingroup lv2 - A generic value container and several data types, see - <http://lv2plug.in/ns/ext/atom> for details. + A generic value container and several data types. + + See <http://lv2plug.in/ns/ext/atom> for details. @{ */ diff --git a/lv2/atom/forge.h b/lv2/atom/forge.h index 05fc539..037088a 100644 --- a/lv2/atom/forge.h +++ b/lv2/atom/forge.h @@ -42,6 +42,9 @@ /** @defgroup forge Forge @ingroup atom + + An API for constructing LV2 atoms. + @{ */ diff --git a/lv2/atom/util.h b/lv2/atom/util.h index 6f3158f..bfad422 100644 --- a/lv2/atom/util.h +++ b/lv2/atom/util.h @@ -25,6 +25,9 @@ /** @defgroup util Utilities @ingroup atom + + Utilities for working with atoms. + @{ */ diff --git a/lv2/buf-size/buf-size.h b/lv2/buf-size/buf-size.h index ae86545..66f7de4 100644 --- a/lv2/buf-size/buf-size.h +++ b/lv2/buf-size/buf-size.h @@ -21,8 +21,9 @@ @defgroup buf-size Buffer Size @ingroup lv2 - Access to, and restrictions on, buffer sizes; see - <http://lv2plug.in/ns/ext/buf-size> for details. + Access to, and restrictions on, buffer sizes. + + See <http://lv2plug.in/ns/ext/buf-size> for details. @{ */ diff --git a/lv2/core/lv2.h b/lv2/core/lv2.h index 9b2de6f..7444b87 100644 --- a/lv2/core/lv2.h +++ b/lv2/core/lv2.h @@ -29,7 +29,9 @@ /** @defgroup lv2core LV2 Core - Core LV2 specification, see <http://lv2plug.in/ns/lv2core> for details. + Core LV2 specification. + + See <http://lv2plug.in/ns/lv2core> for details. @{ */ diff --git a/lv2/data-access/data-access.h b/lv2/data-access/data-access.h index f57b1e2..3cb4624 100644 --- a/lv2/data-access/data-access.h +++ b/lv2/data-access/data-access.h @@ -19,8 +19,9 @@ @defgroup data-access Data Access @ingroup lv2 - Access to plugin extension_data() for UIs, see - <http://lv2plug.in/ns/ext/data-access> for details. + 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 16274e4..5430f37 100644 --- a/lv2/dynmanifest/dynmanifest.h +++ b/lv2/dynmanifest/dynmanifest.h @@ -19,8 +19,9 @@ @defgroup dynmanifest Dynamic Manifest @ingroup lv2 - Support for dynamic data generation, see - <http://lv2plug.in/ns/ext/dynmanifest> for details. + 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 aa67390..7128c66 100644 --- a/lv2/event/event.h +++ b/lv2/event/event.h @@ -19,8 +19,9 @@ @defgroup event Event @ingroup lv2 - Generic time-stamped events, see <http://lv2plug.in/ns/ext/event> for - details. + 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 6a58541..17c5a73 100644 --- a/lv2/instance-access/instance-access.h +++ b/lv2/instance-access/instance-access.h @@ -19,8 +19,9 @@ @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. + 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 8930fac..0d9cfeb 100644 --- a/lv2/log/log.h +++ b/lv2/log/log.h @@ -18,8 +18,9 @@ @defgroup log Log @ingroup lv2 - Interface for plugins to log via the host; see - <http://lv2plug.in/ns/ext/log> for details. + 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 3a9583b..f1e8b62 100644 --- a/lv2/midi/midi.h +++ b/lv2/midi/midi.h @@ -18,8 +18,9 @@ @defgroup midi MIDI @ingroup lv2 - Definitions of standard MIDI messages, see <http://lv2plug.in/ns/ext/midi> - for details. + 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 101df8e..6cef7ac 100644 --- a/lv2/morph/morph.h +++ b/lv2/morph/morph.h @@ -18,8 +18,9 @@ @defgroup morph Morph @ingroup lv2 - Ports that can dynamically change type, see <http://lv2plug.in/ns/ext/morph> - for details. + 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 2ed9f8a..c8c6a43 100644 --- a/lv2/options/options.h +++ b/lv2/options/options.h @@ -18,8 +18,9 @@ @defgroup options Options @ingroup lv2 - Instantiation time options, see <http://lv2plug.in/ns/ext/options> for - details. + 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 01c6dde..aed949e 100644 --- a/lv2/parameters/parameters.h +++ b/lv2/parameters/parameters.h @@ -18,8 +18,9 @@ @defgroup parameters Parameters @ingroup lv2 - Common parameters for audio processing, see - <http://lv2plug.in/ns/ext/parameters>. + Common parameters for audio processing. + + See <http://lv2plug.in/ns/ext/parameters> for details. @{ */ diff --git a/lv2/patch/patch.h b/lv2/patch/patch.h index a721c5e..6793ef8 100644 --- a/lv2/patch/patch.h +++ b/lv2/patch/patch.h @@ -18,12 +18,13 @@ @defgroup patch Patch @ingroup lv2 - Messages for accessing and manipulating properties, see - <http://lv2plug.in/ns/ext/patch> for details. + Messages for accessing and manipulating properties. Note the patch extension is purely data, this header merely defines URIs for convenience. + 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 4c5699f..592be5e 100644 --- a/lv2/port-groups/port-groups.h +++ b/lv2/port-groups/port-groups.h @@ -18,8 +18,9 @@ @defgroup port-groups Port Groups @ingroup lv2 - Multi-channel groups of LV2 ports, see - <http://lv2plug.in/ns/ext/port-groups> for details. + Multi-channel groups of LV2 ports. + + See <http://lv2plug.in/ns/ext/port-groups> for details. @{ */ diff --git a/lv2/presets/presets.h b/lv2/presets/presets.h index 8264a9c..2fc9799 100644 --- a/lv2/presets/presets.h +++ b/lv2/presets/presets.h @@ -18,7 +18,9 @@ @defgroup presets Presets @ingroup lv2 - Presets for plugins, see <http://lv2plug.in/ns/ext/presets> for details. + Presets for plugins. + + See <http://lv2plug.in/ns/ext/presets> for details. @{ */ diff --git a/lv2/state/state.h b/lv2/state/state.h index 2823989..367ef23 100644 --- a/lv2/state/state.h +++ b/lv2/state/state.h @@ -19,8 +19,9 @@ @defgroup state State @ingroup lv2 - An interface for LV2 plugins to save and restore state, see - <http://lv2plug.in/ns/ext/state> for details. + 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 912d732..24987e1 100644 --- a/lv2/time/time.h +++ b/lv2/time/time.h @@ -18,12 +18,13 @@ @defgroup time Time @ingroup lv2 - Properties for describing time, see <http://lv2plug.in/ns/ext/time> for - details. + Properties for describing time. Note the time extension is purely data, this header merely defines URIs for convenience. + See <http://lv2plug.in/ns/ext/time> for details. + @{ */ diff --git a/lv2/ui/ui.h b/lv2/ui/ui.h index 42e0f51..828a8e1 100644 --- a/lv2/ui/ui.h +++ b/lv2/ui/ui.h @@ -20,8 +20,9 @@ @defgroup ui User Interfaces @ingroup lv2 - User interfaces of any type for plugins, - <http://lv2plug.in/ns/extensions/ui> for details. + User interfaces of any type for plugins. + + See <http://lv2plug.in/ns/extensions/ui> for details. @{ */ diff --git a/lv2/units/units.h b/lv2/units/units.h index caea38d..333e735 100644 --- a/lv2/units/units.h +++ b/lv2/units/units.h @@ -18,8 +18,9 @@ @defgroup units Units @ingroup lv2 - Units for LV2 values, see <http://lv2plug.in/ns/extensions/units> for - details. + 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 651c3a8..dac7447 100644 --- a/lv2/uri-map/uri-map.h +++ b/lv2/uri-map/uri-map.h @@ -18,7 +18,7 @@ @defgroup uri-map URI Map @ingroup lv2 - C API for the LV2 URI Map extension <http://lv2plug.in/ns/ext/uri-map>. + A feature for mapping URIs to integers. This extension defines a simple mechanism for plugins to map URIs to integers, usually for performance reasons (e.g. processing events typed by @@ -28,6 +28,8 @@ This allows the extensibility of RDF with the performance of integers (or centrally defined enumerations). + See <http://lv2plug.in/ns/ext/uri-map> for details. + @{ */ diff --git a/lv2/urid/urid.h b/lv2/urid/urid.h index a68bc12..e96efa7 100644 --- a/lv2/urid/urid.h +++ b/lv2/urid/urid.h @@ -19,8 +19,9 @@ @defgroup urid URID @ingroup lv2 - Features for mapping URIs to and from integers, see - <http://lv2plug.in/ns/ext/urid> for details. + 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 69cc1d3..2150702 100644 --- a/lv2/worker/worker.h +++ b/lv2/worker/worker.h @@ -18,8 +18,9 @@ @defgroup worker Worker @ingroup lv2 - Support for non-realtime plugin operations, see - <http://lv2plug.in/ns/ext/worker> for details. + Support for non-realtime plugin operations. + + See <http://lv2plug.in/ns/ext/worker> for details. @{ */ |