Mercurial > hg > vamp-plugin-sdk

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Some doc updates
author cannam
date Wed, 21 Mar 2007 14:15:25 +0000
parents aa64a46320d4
children fa79c4ec847d 9d3272c7db60
line wrap: on
line diff
--- a/vamp-sdk/Plugin.h	Mon Mar 12 11:00:11 2007 +0000
+++ b/vamp-sdk/Plugin.h	Wed Mar 21 14:15:25 2007 +0000
@@ -55,12 +55,10 @@
  * input.
  *
  * Note that this class inherits several abstract methods from
- * PluginBase, that must be implemented by the subclass.
- */
-
-/**
- * Plugin Lifecycle
- * ================
+ * PluginBase.  These must be implemented by the subclass.
+ * 
+ * 
+ * PLUGIN LIFECYCLE
  *
  * Feature extraction plugins are managed differently from real-time
  * plugins (such as VST effects).  The main difference is that the
@@ -379,6 +377,11 @@
      */
     virtual FeatureSet getRemainingFeatures() = 0;
 
+    /**
+     * Used to distinguish between Vamp::Plugin and other potential
+     * sibling subclasses of PluginBase.  Do not implement this
+     * function in your subclass.
+     */
     virtual std::string getType() const { return "Feature Extraction Plugin"; }
 
 protected: