Add comment about AudioDialog.

[dcpomatic.git] / src / wx / audio_dialog.h

diff --git a/src/wx/audio_dialog.h b/src/wx/audio_dialog.h
index 2767a7f5926100698c4b5917afd66372f0972cfe..8c2001c174ee31e963e7c67b8670a324ccfb891f 100644 (file)
--- a/src/wx/audio_dialog.h
+++ b/src/wx/audio_dialog.h
@@ -20,7 +20,8 @@
 
 
 #include "lib/audio_analysis.h"
-#include "lib/film.h"
+#include "lib/constants.h"
+#include "lib/film_property.h"
 #include "lib/playlist.h"
 #include <dcp/warnings.h>
 LIBDCP_DISABLE_WARNINGS
@@ -35,6 +36,11 @@ class FilmViewer;
 class Film;
 
 
+/** @class AudioDialog
+ *  @brief Dialog to display audio analysis.
+ *
+ *  This can be used for the whole DCP, or a specific piece of content if one is passed into the constructor.
+ */
 class AudioDialog : public wxDialog
 {
 public:
@@ -45,7 +51,7 @@ public:
        void set_cursor (boost::optional<dcpomatic::DCPTime> time, boost::optional<float> db);
 
 private:
-       void film_change (ChangeType, Film::Property);
+       void film_change(ChangeType, FilmProperty);
        void content_change (ChangeType, int);
        void channel_clicked (wxCommandEvent &);
        void type_clicked (wxCommandEvent &);