diff --git a/source/includes/lv2/parameters.h b/source/includes/lv2/parameters.h index 9c06babc8..70235b7ae 100644 --- a/source/includes/lv2/parameters.h +++ b/source/includes/lv2/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 + . + + @{ +*/ + #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/source/includes/lv2/patch.h b/source/includes/lv2/patch.h index 32242646c..f24a8b7cb 100644 --- a/source/includes/lv2/patch.h +++ b/source/includes/lv2/patch.h @@ -15,11 +15,15 @@ */ /** - @file patch.h C header for the LV2 Patch extension - . + @defgroup patch Patch - The patch extension is purely data, this header merely defines URIs - for convenience. + Messages for accessing and manipulating properties, see + for details. + + Note the patch extension is purely data, this header merely defines URIs for + convenience. + + @{ */ #ifndef LV2_PATCH_H @@ -30,6 +34,7 @@ #define LV2_PATCH__Ack LV2_PATCH_PREFIX "Ack" #define LV2_PATCH__Delete LV2_PATCH_PREFIX "Delete" +#define LV2_PATCH__Copy LV2_PATCH_PREFIX "Copy" #define LV2_PATCH__Error LV2_PATCH_PREFIX "Error" #define LV2_PATCH__Get LV2_PATCH_PREFIX "Get" #define LV2_PATCH__Message LV2_PATCH_PREFIX "Message" @@ -54,3 +59,7 @@ #define LV2_PATCH__writable LV2_PATCH_PREFIX "writable" #endif /* LV2_PATCH_H */ + +/** + @} +*/ diff --git a/source/includes/lv2/port-groups.h b/source/includes/lv2/port-groups.h index 4dd8cf4eb..6e8029473 100644 --- a/source/includes/lv2/port-groups.h +++ b/source/includes/lv2/port-groups.h @@ -15,9 +15,12 @@ */ /** - @file port-groups.h - C definitions for the LV2 Port Groups extension - . + @defgroup port-groups Port Groups + + Multi-channel groups of LV2 ports, see + 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/source/includes/lv2/port-props.h b/source/includes/lv2/port-props.h index 11274cc44..32e110ae8 100644 --- a/source/includes/lv2/port-props.h +++ b/source/includes/lv2/port-props.h @@ -15,9 +15,11 @@ */ /** - @file port-props.h - C definitions for the LV2 Port Props extension - . + @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/source/includes/lv2/presets.h b/source/includes/lv2/presets.h index 4851febee..22d91a693 100644 --- a/source/includes/lv2/presets.h +++ b/source/includes/lv2/presets.h @@ -15,10 +15,11 @@ */ /** - @file presets.h + @defgroup presets Presets - C definitions for the LV2 Presets extension - . + Presets for plugins, see 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/source/includes/lv2/units.h b/source/includes/lv2/units.h index a40f0973a..e61af2a18 100644 --- a/source/includes/lv2/units.h +++ b/source/includes/lv2/units.h @@ -15,9 +15,12 @@ */ /** - @file units.h - C definitions for the LV2 Units extension - . + @defgroup units Units + + Units for LV2 values, see 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/source/includes/lv2/uri-map.h b/source/includes/lv2/uri-map.h index 2062af3a4..dd0334503 100644 --- a/source/includes/lv2/uri-map.h +++ b/source/includes/lv2/uri-map.h @@ -15,8 +15,9 @@ */ /** - @file - C header for the LV2 URI Map extension . + @defgroup uri-map URI Map + + C API for the LV2 URI Map extension . 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/source/includes/lv2/urid.h b/source/includes/lv2/urid.h index c317f7ff8..ae1f113f4 100644 --- a/source/includes/lv2/urid.h +++ b/source/includes/lv2/urid.h @@ -16,8 +16,12 @@ */ /** - @file urid.h - C header for the LV2 URID extension + @defgroup urid URID + + Features for mapping URIs to and from integers, see + for details. + + @{ */ #ifndef LV2_URID_H @@ -106,11 +110,11 @@ typedef struct _LV2_URID_Unmap { /** Get the URI for a previously mapped numeric ID. - Returns NULL if @p urid is not yet mapped. Otherwise, the corresponding + Returns NULL if `urid` is not yet mapped. Otherwise, the corresponding URI is returned in a canonical form. This MAY not be the exact same string that was originally passed to LV2_URID_Map::map(), but it MUST be an identical URI according to the URI syntax specification (RFC3986). A - non-NULL return for a given @p urid will always be the same for the life + non-NULL return for a given `urid` will always be the same for the life of the plugin. Plugins that intend to perform string comparison on unmapped URIs SHOULD first canonicalise URI strings with a call to map_uri() followed by a call to unmap_uri(). @@ -127,3 +131,7 @@ typedef struct _LV2_URID_Unmap { #endif #endif /* LV2_URID_H */ + +/** + @} +*/