renamed 'timer' to duration; minimal doxygen comments

svn-id: r11040

2 files changed, 9 insertions, 3 deletions

diff --git a/gui/message.cpp b/gui/message.cpp
index 830c790668..3df501225f 100644
--- a/gui/message.cpp
+++ b/gui/message.cpp
@@ -148,9 +148,9 @@ void MessageDialog::handleCommand(CommandSender *sender, uint32 cmd, uint32 data
 	}
 }
 
-TimedMessageDialog::TimedMessageDialog(NewGui *gui, const Common::String &message, uint32 timer)
+TimedMessageDialog::TimedMessageDialog(NewGui *gui, const Common::String &message, uint32 duration)
 	: MessageDialog(gui, message, 0, 0) {
-	_timer = _gui->get_time() + timer;
+	_timer = _gui->get_time() + duration;
 }
 
 void TimedMessageDialog::handleTickle() {
diff --git a/gui/message.h b/gui/message.h
index 42879b84eb..32b94573d2 100644
--- a/gui/message.h
+++ b/gui/message.h
@@ -28,6 +28,9 @@ namespace Common {
 	class StringList;
 }
 
+/**
+ * Simple message dialog ("alert box"): presents a text message in a dialog with up to two buttons.
+ */
 class MessageDialog : public Dialog {
 	typedef Common::String String;
 	typedef Common::StringList StringList;
@@ -40,9 +43,12 @@ protected:
 	int addLine(Common::StringList &lines, const char *line, int size);
 };
 
+/**
+ * Timed message dialog: displays a message to the user for brief time period.
+ */
 class TimedMessageDialog : public MessageDialog {
 public:
-	TimedMessageDialog(NewGui *gui, const Common::String &message, uint32 timer);
+	TimedMessageDialog(NewGui *gui, const Common::String &message, uint32 duration);
 
 	void handleTickle();