Some doxygen documentation improvements.

3 files changed, 25 insertions, 2 deletions

diff --git a/src/wx/film_viewer.cc b/src/wx/film_viewer.cc
index 56f20449b..0d17baf83 100644
--- a/src/wx/film_viewer.cc
+++ b/src/wx/film_viewer.cc
@@ -47,6 +47,7 @@ public:
 	{
 	}
 
+	/** Handle a paint event */
 	void paint_event (wxPaintEvent& ev)
 	{
 		if (_current_image != _pending_image) {
@@ -67,6 +68,7 @@ public:
 		}
 	}
 
+	/** Handle a size event */
 	void size_event (wxSizeEvent &)
 	{
 		if (!_image) {
@@ -101,6 +103,7 @@ public:
 		}
 	}
 
+	/** Clear our thumbnail image */
 	void clear ()
 	{
 		delete _bitmap;
diff --git a/src/wx/wx_util.cc b/src/wx/wx_util.cc
index 44d9462e5..4277ed12d 100644
--- a/src/wx/wx_util.cc
+++ b/src/wx/wx_util.cc
@@ -27,6 +27,12 @@
 using namespace std;
 using namespace boost;
 
+/** Add a wxStaticText to a wxSizer, aligning it at vertical centre.
+ *  @param s Sizer to add to.
+ *  @param p Parent window for the wxStaticText.
+ *  @param t Text for the wxStaticText.
+ *  @param prop Properties to pass when calling Add() on the wxSizer.
+ */
 wxStaticText *
 add_label_to_sizer (wxSizer* s, wxWindow* p, string t, int prop)
 {
@@ -35,6 +41,10 @@ add_label_to_sizer (wxSizer* s, wxWindow* p, string t, int prop)
 	return m;
 }
 
+/** Pop up an error dialogue box.
+ *  @param parent Parent.
+ *  @param m Message.
+ */
 void
 error_dialog (wxWindow* parent, string m)
 {
@@ -43,12 +53,18 @@ error_dialog (wxWindow* parent, string m)
 	d->Destroy ();
 }
 
+/** @param s wxWidgets string.
+ *  @return Corresponding STL string.
+ */
 string
 wx_to_std (wxString s)
 {
 	return string (s.mb_str ());
 }
 
+/** @param s STL string.
+ *  @return Corresponding wxWidgets string.
+ */
 wxString
 std_to_wx (string s)
 {
@@ -75,15 +91,16 @@ ThreadedStaticText::~ThreadedStaticText ()
 	delete _thread;
 }
 
+/** Run our thread and post the result to the GUI thread via AddPendingEvent */
 void
 ThreadedStaticText::run (function<string ()> fn)
 {
-	/* Run the thread and post the result to the GUI thread via AddPendingEvent */
 	wxCommandEvent ev (wxEVT_COMMAND_TEXT_UPDATED, _update_event_id);
 	ev.SetString (std_to_wx (fn ()));
 	GetEventHandler()->AddPendingEvent (ev);
 }
 
+/** Called in the GUI thread when our worker thread has finished */
 void
 ThreadedStaticText::thread_finished (wxCommandEvent& ev)
 {
diff --git a/src/wx/wx_util.h b/src/wx/wx_util.h
index 3a454c7c4..12a6e8837 100644
--- a/src/wx/wx_util.h
+++ b/src/wx/wx_util.h
@@ -30,7 +30,9 @@ extern wxStaticText* add_label_to_sizer (wxSizer *, wxWindow *, std::string, int
 extern std::string wx_to_std (wxString);
 extern wxString std_to_wx (std::string);
 
-/** A wxStaticText whose content is computed in a separate thread, to avoid holding
+/** @class ThreadedStaticText
+ *
+ *  @brief A wxStaticText whose content is computed in a separate thread, to avoid holding
  *  up the GUI while work is done.
  */
 class ThreadedStaticText : public wxStaticText
@@ -43,6 +45,7 @@ private:
 	void run (boost::function<std::string ()> fn);
 	void thread_finished (wxCommandEvent& ev);
 
+	/** Thread to do our work in */
 	boost::thread* _thread;
 	
 	static const int _update_event_id;