From 04c56a0618f668fac288fb2070fcf200a83aebc6 Mon Sep 17 00:00:00 2001 From: Robin Gareus Date: Tue, 12 Apr 2016 17:03:44 +0200 Subject: some strategic documentation Prevent class descriptions inheriting the doc from PBD:Stateful by adding some specific doc. --- libs/ardour/ardour/plugin.h | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'libs/ardour/ardour/plugin.h') 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 PluginPtr; typedef boost::shared_ptr PluginInfoPtr; typedef std::list 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: -- cgit v1.2.3