diff options
| author | Robin Gareus <robin@gareus.org> | 2016-04-12 17:03:44 +0200 |
|---|---|---|
| committer | Robin Gareus <robin@gareus.org> | 2016-04-12 17:03:44 +0200 |
| commit | 04c56a0618f668fac288fb2070fcf200a83aebc6 (patch) | |
| tree | e57202847f903f02073c3b649dd1e3170c41822e /libs/ardour/ardour/plugin.h | |
| parent | dd57b33b2692e0a197d486f721eeac8168f9016a (diff) | |
some strategic documentation
Prevent class descriptions inheriting the doc from PBD:Stateful by
adding some specific doc.
Diffstat (limited to 'libs/ardour/ardour/plugin.h')
| -rw-r--r-- | libs/ardour/ardour/plugin.h | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/libs/ardour/ardour/plugin.h b/libs/ardour/ardour/plugin.h index 087f5968bd..e48201e73c 100644 --- 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: |