summaryrefslogtreecommitdiff
path: root/src/wx
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2017-03-02 15:37:13 +0000
committerCarl Hetherington <cth@carlh.net>2017-04-19 23:04:32 +0100
commit67a68bd971ebe1b35daa3f75873b4ccb53c00ba0 (patch)
tree9b1fea4070c3b15f346cc57075bbeed1b963329d /src/wx
parent3449bc0a6d6e77e851240a0953363f5a07ec6517 (diff)
Various Doxygen fixes.
Diffstat (limited to 'src/wx')
-rw-r--r--src/wx/audio_dialog.cc5
-rw-r--r--src/wx/audio_dialog.h2
-rw-r--r--src/wx/content_widget.h3
-rw-r--r--src/wx/film_editor.cc1
-rw-r--r--src/wx/isdcf_metadata_dialog.cc5
-rw-r--r--src/wx/report_problem_dialog.cc4
-rw-r--r--src/wx/report_problem_dialog.h3
-rw-r--r--src/wx/system_font_dialog.h2
8 files changed, 17 insertions, 8 deletions
diff --git a/src/wx/audio_dialog.cc b/src/wx/audio_dialog.cc
index ebccd53f5..8a38c8a87 100644
--- a/src/wx/audio_dialog.cc
+++ b/src/wx/audio_dialog.cc
@@ -41,7 +41,10 @@ using boost::optional;
using boost::const_pointer_cast;
using boost::dynamic_pointer_cast;
-/** @param content Content to analyse, or 0 to analyse all of the film's audio */
+/** @param parent Parent window.
+ * @param film Film we are using.
+ * @param content Content to analyse, or 0 to analyse all of the film's audio.
+ */
AudioDialog::AudioDialog (wxWindow* parent, shared_ptr<Film> film, shared_ptr<Content> content)
: wxDialog (
parent,
diff --git a/src/wx/audio_dialog.h b/src/wx/audio_dialog.h
index 37d425624..41be90b79 100644
--- a/src/wx/audio_dialog.h
+++ b/src/wx/audio_dialog.h
@@ -31,7 +31,7 @@ class Film;
class AudioDialog : public wxDialog
{
public:
- AudioDialog (wxWindow *, boost::shared_ptr<Film> film, boost::shared_ptr<Content> content = boost::shared_ptr<Content> ());
+ AudioDialog (wxWindow* parent, boost::shared_ptr<Film> film, boost::shared_ptr<Content> content = boost::shared_ptr<Content> ());
bool Show (bool show = true);
diff --git a/src/wx/content_widget.h b/src/wx/content_widget.h
index 744d0a7a2..e162aca49 100644
--- a/src/wx/content_widget.h
+++ b/src/wx/content_widget.h
@@ -49,8 +49,11 @@ public:
/** @param parent Parent window.
* @param wrapped Control widget that we are wrapping.
* @param property ContentProperty that the widget is handling.
+ * @param part Part of Content that the property is in (e.g. &Content::video)
* @param model_getter Function on the Content to get the value.
* @param model_setter Function on the Content to set the value.
+ * @param view_to_model Function to convert a view value to a model value.
+ * @param model_to_view Function to convert a model value to a view value.
*/
ContentWidget (
wxWindow* parent,
diff --git a/src/wx/film_editor.cc b/src/wx/film_editor.cc
index edf5d3bd7..7dd7e4ef3 100644
--- a/src/wx/film_editor.cc
+++ b/src/wx/film_editor.cc
@@ -41,7 +41,6 @@ using std::list;
using boost::shared_ptr;
using boost::optional;
-/** @param f Film to edit */
FilmEditor::FilmEditor (wxWindow* parent, FilmViewer* viewer)
: wxPanel (parent)
{
diff --git a/src/wx/isdcf_metadata_dialog.cc b/src/wx/isdcf_metadata_dialog.cc
index bef0851e0..ee7d4ae70 100644
--- a/src/wx/isdcf_metadata_dialog.cc
+++ b/src/wx/isdcf_metadata_dialog.cc
@@ -27,7 +27,10 @@
using boost::shared_ptr;
-/** @param threed true if the film is in 3D */
+/** @param parent Parent window.
+ * @param dm Initial ISDCF metadata.
+ * @param threed true if the film is in 3D.
+ */
ISDCFMetadataDialog::ISDCFMetadataDialog (wxWindow* parent, ISDCFMetadata dm, bool threed)
: TableDialog (parent, _("ISDCF name"), 2, 1, true)
{
diff --git a/src/wx/report_problem_dialog.cc b/src/wx/report_problem_dialog.cc
index 7519259eb..77540fcbc 100644
--- a/src/wx/report_problem_dialog.cc
+++ b/src/wx/report_problem_dialog.cc
@@ -28,7 +28,9 @@
using std::string;
using boost::shared_ptr;
-/** @param film Film that we are working on, or 0 */
+/** @param parent Parent window.
+ * @param film Film that we are working on, or 0.
+ */
ReportProblemDialog::ReportProblemDialog (wxWindow* parent, shared_ptr<Film> film)
: wxDialog (parent, wxID_ANY, _("Report A Problem"))
, _film (film)
diff --git a/src/wx/report_problem_dialog.h b/src/wx/report_problem_dialog.h
index fda3761d3..a13c6a671 100644
--- a/src/wx/report_problem_dialog.h
+++ b/src/wx/report_problem_dialog.h
@@ -29,7 +29,7 @@ class Film;
class ReportProblemDialog : public wxDialog
{
public:
- ReportProblemDialog (wxWindow* parent, boost::shared_ptr<Film>);
+ ReportProblemDialog (wxWindow* parent, boost::shared_ptr<Film> film);
void report ();
@@ -42,4 +42,3 @@ private:
wxCheckBox* _send_logs;
wxTextCtrl* _email;
};
-
diff --git a/src/wx/system_font_dialog.h b/src/wx/system_font_dialog.h
index 35ed0827e..9cced4956 100644
--- a/src/wx/system_font_dialog.h
+++ b/src/wx/system_font_dialog.h
@@ -22,7 +22,7 @@
* @brief A dialog box to select one of the "system" fonts on Windows.
*
* This is necessary because wxFileDialog on Windows will not display
- * the contents of c:\Windows\Fonts, so we need a different way to choose
+ * the contents of `c:\Windows\Fonts`, so we need a different way to choose
* one of those fonts.
*/