diff vamp-sdk/hostext/PluginWrapper.h @ 62:fe5486ee1c70 host-factory-stuff

* Documentation
author cannam
date Fri, 01 Jun 2007 15:00:51 +0000
parents fa79c4ec847d
children
line wrap: on
line diff
--- a/vamp-sdk/hostext/PluginWrapper.h	Fri Jun 01 13:53:42 2007 +0000
+++ b/vamp-sdk/hostext/PluginWrapper.h	Fri Jun 01 15:00:51 2007 +0000
@@ -43,6 +43,15 @@
 
 namespace HostExt {
 
+/**
+ * PluginWrapper is a simple base class for adapter plugins.  It takes
+ * a pointer to a "to be wrapped" Vamp plugin on construction, and
+ * provides implementations of all the Vamp plugin methods that simply
+ * delegate through to the wrapped plugin.  A subclass can therefore
+ * override only the methods that are meaningful for the particular
+ * adapter.
+ */
+
 class PluginWrapper : public Plugin
 {
 public: