From: Robin Gareus <robin@gareus.org>
Date: Wed, 30 Mar 2016 23:10:51 +0000 (+0200)
Subject: Add a few class documentations to override inherited doc.
X-Git-Tag: 5.0-pre0~1146
X-Git-Url: https://main.carlh.net/gitweb/?a=commitdiff_plain;h=a9187a9e25b1e44c4d15132b24d189db564fb924;p=ardour.git

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 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:
diff --git a/libs/pbd/pbd/statefuldestructible.h b/libs/pbd/pbd/statefuldestructible.h
index 501633d517..4c321d2cc0 100644
--- 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
 {
 };