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 | |
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')
-rw-r--r-- | libs/ardour/ardour/location.h | 1 | ||||
-rw-r--r-- | libs/ardour/ardour/plugin.h | 8 | ||||
-rw-r--r-- | libs/ardour/ardour/track.h | 5 |
3 files changed, 14 insertions, 0 deletions
diff --git a/libs/ardour/ardour/location.h b/libs/ardour/ardour/location.h index fccccac144..530f757c65 100644 --- a/libs/ardour/ardour/location.h +++ b/libs/ardour/ardour/location.h @@ -164,6 +164,7 @@ class LIBARDOUR_API Location : public SessionHandleRef, public PBD::StatefulDest void recompute_bbt_from_frames (); }; +/** A collection of session locations including unique dedicated locations (loop, punch, etc) */ class LIBARDOUR_API Locations : public SessionHandleRef, public PBD::StatefulDestructible { public: 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: diff --git a/libs/ardour/ardour/track.h b/libs/ardour/ardour/track.h index da5e2bbae8..c49cbd00e2 100644 --- a/libs/ardour/ardour/track.h +++ b/libs/ardour/ardour/track.h @@ -35,6 +35,11 @@ class Region; class Diskstream; class IO; +/** A track is an route (bus) with a recordable diskstream and + * related objects relevant to tracking, playback and editing. + * + * Specifically a track has regions and playlist objects. + */ class LIBARDOUR_API Track : public Route, public PublicDiskstream { public: |