Hide warnings triggered by Ubuntu 20.04's gcc.
[dcpomatic.git] / src / wx / about_dialog.h
index a78abb93e267fe1c1c7c60187a4a3edcef1b44af..f3bb65a6c9d95e2868b8f725ad359ead00d664b4 100644 (file)
@@ -1,34 +1,44 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
+/** @file  src/wx/about_dialog.h
+ *  @brief The "about DCP-o-matic" dialogue box.
+ */
+
+#include "lib/warnings.h"
+DCPOMATIC_DISABLE_WARNINGS
 #include <wx/wx.h>
+DCPOMATIC_ENABLE_WARNINGS
 
 class wxNotebook;
 
+/** @class AboutDialog
+ *  @brief The "about DCP-o-matic" dialogue box.
+ */
 class AboutDialog : public wxDialog
 {
 public:
-       AboutDialog (wxWindow *);
+       explicit AboutDialog (wxWindow *);
 
 private:
        void add_section (wxString, wxArrayString);
 
-       wxNotebook* _notebook;
+       wxNotebook* _notebook; ///< notebook used to keep each list of names for the credits
 };
-