diff vamp-hostsdk/PluginChannelAdapter.h @ 248:c88a3cdb0215

* Tidy up --list-full output a bit * Some documentation, including docs for PluginSummarisingAdapter
author cannam
date Tue, 11 Nov 2008 12:07:09 +0000
parents 3cf5bd155e5b
children 4454843ff384
line wrap: on
line diff
--- a/vamp-hostsdk/PluginChannelAdapter.h	Tue Nov 11 09:49:12 2008 +0000
+++ b/vamp-hostsdk/PluginChannelAdapter.h	Tue Nov 11 12:07:09 2008 +0000
@@ -110,7 +110,12 @@
 class PluginChannelAdapter : public PluginWrapper
 {
 public:
-    PluginChannelAdapter(Plugin *plugin); // I take ownership of plugin
+    /**
+     * Construct a PluginChannelAdapter wrapping the given plugin.
+     * The adapter takes ownership of the plugin, which will be
+     * deleted when the adapter is deleted.
+     */
+    PluginChannelAdapter(Plugin *plugin);
     virtual ~PluginChannelAdapter();
 
     bool initialise(size_t channels, size_t stepSize, size_t blockSize);