some strategic documentation

[ardour.git] / libs / ardour / ardour / plugin.h

diff --git a/libs/ardour/ardour/plugin.h b/libs/ardour/ardour/plugin.h
index 087f5968bd0e66586d60a2e8856d7dfa7dd171a2..e48201e73c4b9255dfb5566f05cb9e85bb2ea343 100644 (file)
--- a/libs/ardour/ardour/plugin.h
+++ b/libs/ardour/ardour/plugin.h
@@ -55,6 +55,14 @@ typedef boost::shared_ptr<Plugin> PluginPtr;
 typedef boost::shared_ptr<PluginInfo> PluginInfoPtr;
 typedef std::list<PluginInfoPtr> PluginInfoList;
 
+/** A plugin is an external module (usually 3rd party provided) loaded into Ardour
+ * for the purpose of digital signal processing.
+ *
+ * This class provides an abstraction for methords provided by
+ * all supported plugin standards such as presets, name, parameters etc.
+ *
+ * Plugins are not used directly in Ardour but always wrapped by a PluginInsert.
+ */
 class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
 {
   public: