summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2014-07-10 11:43:17 +0100
committerCarl Hetherington <cth@carlh.net>2014-07-10 11:43:17 +0100
commit38164bf6e8095f8a8f852bd21877cfb90d204868 (patch)
tree828169b92ce013609d7127c1c8ab6d2a4ab0566b /src/lib
parent6dc102cef17ac0b3f3089985813c58bc16058e66 (diff)
Docs.
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/audio_examiner.h7
-rw-r--r--src/lib/audio_mapping.h8
2 files changed, 14 insertions, 1 deletions
diff --git a/src/lib/audio_examiner.h b/src/lib/audio_examiner.h
index 64a98ba17..d6d4dbe97 100644
--- a/src/lib/audio_examiner.h
+++ b/src/lib/audio_examiner.h
@@ -17,6 +17,13 @@
*/
+/** @file src/lib/audio_examiner.h
+ * @brief AudioExaminer class.
+ */
+
+/** @class AudioExaminer
+ * @brief Parent for classes which examine AudioContent for their pertinent details.
+ */
class AudioExaminer
{
public:
diff --git a/src/lib/audio_mapping.h b/src/lib/audio_mapping.h
index 8be8eeb6f..a76d83a37 100644
--- a/src/lib/audio_mapping.h
+++ b/src/lib/audio_mapping.h
@@ -17,6 +17,10 @@
*/
+/** @file src/lib/audio_mapping.h
+ * @brief AudioMapping class.
+ */
+
#ifndef DCPOMATIC_AUDIO_MAPPING_H
#define DCPOMATIC_AUDIO_MAPPING_H
@@ -33,7 +37,9 @@ namespace cxml {
class Node;
}
-/** A many-to-many mapping from some content channels to DCP channels.
+/** @class AudioMapping.
+ * @brief A many-to-many mapping from some content channels to DCP channels.
+ *
* The number of content channels is set on construction and fixed,
* and then each of those content channels are mapped to each DCP channel
* by a linear gain.