diff options
author | Robin Gareus <robin@gareus.org> | 2016-03-31 01:10:51 +0200 |
---|---|---|
committer | Robin Gareus <robin@gareus.org> | 2016-03-31 01:16:07 +0200 |
commit | a9187a9e25b1e44c4d15132b24d189db564fb924 (patch) | |
tree | 0b1a80702f89ead11f1d5ead96fa6c7d3ec9b7f9 /libs/ardour/ardour | |
parent | 2a578c245b6077ff4bcdaadc9c445031616bd839 (diff) |
Add a few class documentations to override inherited doc.
clang doxygen comments follows class inheritance.
Undocumented Ardour classes which inherit from sigc::trackable
also inherit sigc's documentation.
Diffstat (limited to 'libs/ardour/ardour')
-rw-r--r-- | libs/ardour/ardour/export_handler.h | 1 | ||||
-rw-r--r-- | libs/ardour/ardour/location.h | 1 | ||||
-rw-r--r-- | libs/ardour/ardour/session.h | 1 | ||||
-rw-r--r-- | libs/ardour/ardour/tempo.h | 3 |
4 files changed, 6 insertions, 0 deletions
diff --git a/libs/ardour/ardour/export_handler.h b/libs/ardour/ardour/export_handler.h index 3d92888d60..7204bc33c8 100644 --- a/libs/ardour/ardour/export_handler.h +++ b/libs/ardour/ardour/export_handler.h @@ -72,6 +72,7 @@ class LIBARDOUR_API ExportElementFactory Session & session; }; +/** Export Handler */ class LIBARDOUR_API ExportHandler : public ExportElementFactory, public sigc::trackable { public: diff --git a/libs/ardour/ardour/location.h b/libs/ardour/ardour/location.h index f564757e1a..fccccac144 100644 --- a/libs/ardour/ardour/location.h +++ b/libs/ardour/ardour/location.h @@ -41,6 +41,7 @@ namespace ARDOUR { class SceneChange; +/** Location on Timeline - abstract representation for Markers, Loop/Punch Ranges, CD-Markers etc. */ class LIBARDOUR_API Location : public SessionHandleRef, public PBD::StatefulDestructible { public: diff --git a/libs/ardour/ardour/session.h b/libs/ardour/ardour/session.h index 49b9d7c45e..4efe41f9cc 100644 --- a/libs/ardour/ardour/session.h +++ b/libs/ardour/ardour/session.h @@ -161,6 +161,7 @@ private: std::string _message; }; +/** Ardour Session */ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager { public: diff --git a/libs/ardour/ardour/tempo.h b/libs/ardour/ardour/tempo.h index c64039bd06..1b43ff8c8c 100644 --- a/libs/ardour/ardour/tempo.h +++ b/libs/ardour/ardour/tempo.h @@ -212,6 +212,9 @@ class LIBARDOUR_API TempoMetric { Timecode::BBT_Time _start; }; +/** Tempo Map - mapping of timecode to musical time. + * convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo + */ class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible { public: |