From: Carl Hetherington <cth@carlh.net>
Date: Sun, 11 Feb 2024 12:08:58 +0000 (+0100)
Subject: Add comment about AudioDialog.
X-Git-Tag: v2.16.76~12
X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=commitdiff_plain;h=cbeedf8849de63c7601d6c5a194cb60ed583c7a0;hp=821b2abc0fe575390afa02faf45db164a22ad9bc

Add comment about AudioDialog.
---

diff --git a/src/wx/audio_dialog.h b/src/wx/audio_dialog.h
index f144fb485..8c2001c17 100644
--- a/src/wx/audio_dialog.h
+++ b/src/wx/audio_dialog.h
@@ -36,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: