Docs.
authorCarl Hetherington <cth@carlh.net>
Thu, 10 Jul 2014 10:43:17 +0000 (11:43 +0100)
committerCarl Hetherington <cth@carlh.net>
Thu, 10 Jul 2014 10:43:17 +0000 (11:43 +0100)
src/lib/audio_examiner.h
src/lib/audio_mapping.h

index 64a98ba1701c4af9d618997e8e758e7edc991778..d6d4dbe9778607dd8448c34893d2c811775354b6 100644 (file)
 
 */
 
+/** @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:
index 8be8eeb6fa030cfbb27099abdf4c18a4d9b3e519..a76d83a370f703dceded47e1d5aff6e90cd472e3 100644 (file)
 
 */
 
+/** @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.