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.

diff --git a/libs/ardour/ardour/export_handler.h b/libs/ardour/ardour/export_handler.h
index 3d92888d60f8db4f544c78d23f132e75ce00f171..7204bc33c87193d42b34720cde56346df96375a7 100644 (file)
--- 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 f564757e1aec382e5a301852bfcdbe8fb164c51b..fccccac14430c2c8e7af52d21720fa91d63a53eb 100644 (file)
--- 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 49b9d7c45e6f2d67c8a70a65fca49c5bd14f562b..4efe41f9cc0114876575178cfa94182dfbee0ed5 100644 (file)
--- 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 c64039bd064ce46b02b46dc09dc412a16abf67da..1b43ff8c8cfb34a9d92b0ad006817eebeb66c962 100644 (file)
--- 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:

diff --git a/libs/pbd/pbd/statefuldestructible.h b/libs/pbd/pbd/statefuldestructible.h
index 501633d5178a53ef2c6b47d04a89ec461c48def4..4c321d2cc0fab0d6bdc1fe5b062b38238b655469 100644 (file)
--- a/libs/pbd/pbd/statefuldestructible.h
+++ b/libs/pbd/pbd/statefuldestructible.h
@@ -26,6 +26,7 @@
 
 namespace PBD {
 
+/** Base class for objects with saveable and undoable state with destruction notification */
 class LIBPBD_API StatefulDestructible : public Stateful, public Destructible
 {
 };