diff vamp-sdk/PluginBase.h @ 53:74822738965b

* Some doc updates
author cannam
date Wed, 21 Mar 2007 14:15:25 +0000
parents b907557b2fb9
children fa79c4ec847d 9d3272c7db60
line wrap: on
line diff
--- a/vamp-sdk/PluginBase.h	Mon Mar 12 11:00:11 2007 +0000
+++ b/vamp-sdk/PluginBase.h	Wed Mar 21 14:15:25 2007 +0000
@@ -46,13 +46,14 @@
 
 /**
  * A base class for plugins with optional configurable parameters,
- * programs, etc.
+ * programs, etc.  The Vamp::Plugin is derived from this, and
+ * individual Vamp plugins should derive from that.
  *
- * This does not provide the necessary interfaces to instantiate or
- * run a plugin -- that depends on the plugin subclass, as different
- * plugin types may have quite different operating structures.  This
- * class just specifies the necessary interface to show editable
- * controls for the plugin to the user.
+ * This class does not provide the necessary interfaces to instantiate
+ * or run a plugin.  It only specifies an interface for retrieving
+ * those controls that the host may wish to show to the user for
+ * editing.  It could meaningfully be subclassed by real-time plugins
+ * or other sorts of plugin as well as Vamp plugins.
  */
 
 class PluginBase