diff options
Diffstat (limited to 'slv2')
| -rw-r--r-- | slv2/plugin.h | 6 | ||||
| -rw-r--r-- | slv2/pluginclass.h | 2 | ||||
| -rw-r--r-- | slv2/pluginclasses.h | 2 | ||||
| -rw-r--r-- | slv2/plugininstance.h | 28 | ||||
| -rw-r--r-- | slv2/plugins.h | 2 | ||||
| -rw-r--r-- | slv2/pluginui.h | 2 | ||||
| -rw-r--r-- | slv2/pluginuiinstance.h | 13 | ||||
| -rw-r--r-- | slv2/pluginuis.h | 2 | ||||
| -rw-r--r-- | slv2/port.h | 2 | ||||
| -rw-r--r-- | slv2/util.h | 2 | ||||
| -rw-r--r-- | slv2/value.h | 2 | ||||
| -rw-r--r-- | slv2/values.h | 2 | ||||
| -rw-r--r-- | slv2/world.h | 2 |
13 files changed, 31 insertions, 36 deletions
diff --git a/slv2/plugin.h b/slv2/plugin.h index c22fda5..b7a436e 100644 --- a/slv2/plugin.h +++ b/slv2/plugin.h @@ -29,10 +29,10 @@ extern "C" { #include <slv2/port.h> #include <slv2/values.h> -/** \defgroup data Plugin data access +/** \defgroup slv2_data Plugin data access * - * These functions work exclusively with the plugin's RDF data. - * They do not load or access the plugin dynamic library in any way. + * These functions work exclusively with the plugin's RDF data, + * they do not access the plugin's shared library in any way. * * An SLV2Plugin contains an in-memory cache of the plugin data, loaded * on demand. Duplicating plugins should be avoided when possible for diff --git a/slv2/pluginclass.h b/slv2/pluginclass.h index 3dacfd7..14449ab 100644 --- a/slv2/pluginclass.h +++ b/slv2/pluginclass.h @@ -25,7 +25,7 @@ extern "C" { #include <slv2/types.h> -/** \addtogroup data +/** \addtogroup slv2_data * @{ */ diff --git a/slv2/pluginclasses.h b/slv2/pluginclasses.h index e95710b..b4cd08d 100644 --- a/slv2/pluginclasses.h +++ b/slv2/pluginclasses.h @@ -25,7 +25,7 @@ extern "C" { #endif -/** \addtogroup collections +/** \addtogroup slv2_collections * @{ */ diff --git a/slv2/plugininstance.h b/slv2/plugininstance.h index a78b644..c960e86 100644 --- a/slv2/plugininstance.h +++ b/slv2/plugininstance.h @@ -28,33 +28,31 @@ extern "C" { #include <slv2/plugin.h> #include <slv2/port.h> -/** \defgroup lib Plugin library access - * - * An SLV2Instance is an instantiated SLV2Plugin (ie a loaded dynamic - * library). These functions interact with the binary library code only, - * they do not read data files in any way. - * - * @{ - */ - - typedef struct _InstanceImpl* SLV2InstanceImpl; - -/** Instance of a plugin. +/* Instance of a plugin. * * The LV2 descriptor and handle of this are exposed to allow inlining of * performance critical functions like slv2_instance_run (which are exposed - * in lv2.h anyway). The remaining implementation details are - * in the opaque pimpl member. + * in lv2.h anyway). This is for performance only, this struct is not + * documented and should not be used directly. The remaining implementation + * details are in the opaque pimpl member. */ -typedef struct _Instance { +typedef struct { const LV2_Descriptor* lv2_descriptor; LV2_Handle lv2_handle; SLV2InstanceImpl pimpl; ///< Private implementation }* SLV2Instance; +/** \defgroup slv2_library Plugin library access + * + * An SLV2Instance is an instantiated SLV2Plugin (ie a loaded dynamic + * library). These functions interact with the binary library code only, + * they do not read data files in any way. + * + * @{ + */ /** Instantiate a plugin. * diff --git a/slv2/plugins.h b/slv2/plugins.h index 1ca4cc7..6b8eead 100644 --- a/slv2/plugins.h +++ b/slv2/plugins.h @@ -26,7 +26,7 @@ extern "C" { #endif -/** \addtogroup collections +/** \addtogroup slv2_collections * @{ */ diff --git a/slv2/pluginui.h b/slv2/pluginui.h index cd5fd3a..7de54aa 100644 --- a/slv2/pluginui.h +++ b/slv2/pluginui.h @@ -23,7 +23,7 @@ extern "C" { #endif -/** \addtogroup data +/** \addtogroup slv2_data * @{ */ diff --git a/slv2/pluginuiinstance.h b/slv2/pluginuiinstance.h index ba2ada6..2723585 100644 --- a/slv2/pluginuiinstance.h +++ b/slv2/pluginuiinstance.h @@ -28,16 +28,9 @@ extern "C" { #include <slv2/lv2_gui.h> #include <slv2/plugin.h> -/** \addtogroup lib - * @{ - */ - - typedef struct _SLV2UIInstanceImpl* SLV2UIInstanceImpl; - - -/** Instance of a plugin UI. +/* Instance of a plugin UI. * * All details are in hidden in the pimpl member to avoid making the * implementation a part of the ABI. @@ -47,6 +40,10 @@ typedef struct _SLV2UIInstance { }* SLV2UIInstance; +/** \addtogroup slv2_library + * @{ + */ + /** Instantiate a plugin UI. * diff --git a/slv2/pluginuis.h b/slv2/pluginuis.h index f3eb699..b14e61a 100644 --- a/slv2/pluginuis.h +++ b/slv2/pluginuis.h @@ -26,7 +26,7 @@ extern "C" { #endif -/** \addtogroup collections +/** \addtogroup slv2_collections * * @{ */ diff --git a/slv2/port.h b/slv2/port.h index dc477cd..2cf0e30 100644 --- a/slv2/port.h +++ b/slv2/port.h @@ -28,7 +28,7 @@ extern "C" { #include <slv2/port.h> #include <slv2/values.h> -/** \addtogroup data +/** \addtogroup slv2_data * @{ */ diff --git a/slv2/util.h b/slv2/util.h index 1bd2847..0313f6e 100644 --- a/slv2/util.h +++ b/slv2/util.h @@ -25,7 +25,7 @@ extern "C" { #endif -/** \defgroup util Utility functions +/** \defgroup slv2_util Utility functions * * @{ */ diff --git a/slv2/value.h b/slv2/value.h index 0d8f9dc..00cd39a 100644 --- a/slv2/value.h +++ b/slv2/value.h @@ -26,7 +26,7 @@ extern "C" { #include <stdbool.h> #include <slv2/types.h> -/** \addtogroup data +/** \addtogroup slv2_data * @{ */ diff --git a/slv2/values.h b/slv2/values.h index 2535bdd..9d6c717 100644 --- a/slv2/values.h +++ b/slv2/values.h @@ -26,7 +26,7 @@ extern "C" { #endif -/** \defgroup collections Collections of values/objects +/** \defgroup slv2_collections Collections of values/objects * * Ordered collections of typed values which are fast for random * access by index (i.e. a fancy array). diff --git a/slv2/world.h b/slv2/world.h index 01e671c..610d830 100644 --- a/slv2/world.h +++ b/slv2/world.h @@ -27,7 +27,7 @@ extern "C" { #endif -/** \defgroup world Global library state +/** \defgroup slv2_world Global library state * * The "world" represents all library state, and the data found in bundles' * manifest.ttl (ie it is an in-memory index of all things LV2 found). |