From ea89f276681305845d30c1d8547ce0c9dbfcd9e9 Mon Sep 17 00:00:00 2001
From: Joel Holdsworth <joel@joel-netbook.(none)>
Date: Fri, 26 Dec 2008 19:10:31 +0000
Subject: [PATCH] Tidied up name-chooser.hpp

---
 src/gui/dialogs/name-chooser.hpp | 26 +++++++++++++++-----------
 1 file changed, 15 insertions(+), 11 deletions(-)

diff --git a/src/gui/dialogs/name-chooser.hpp b/src/gui/dialogs/name-chooser.hpp
index 7cc735bdd..12b30765e 100644
--- a/src/gui/dialogs/name-chooser.hpp
+++ b/src/gui/dialogs/name-chooser.hpp
@@ -33,23 +33,27 @@ namespace gui {
 namespace dialogs {
 
 /** 
- * The defintion of the name chooser dialog class
+ * The name chooser dialog is a modal dialog box that prompts the user
+ * to choose a string name.
  */
 class NameChooser : public Gtk::Dialog
 {
 public:
-
-  enum Action
-  {
-    AddSequence,
-    RenameSequence
-  };
-  
-public:
-
+  /**
+   * Creates a name chooser dialog.
+   * @param parent The window which will be the parent of this dialog.
+   * @param title The string for the title of this dialog.
+   * @param default_name The name that will be shown by default in the
+   * edit box of the dialog.
+   **/
   NameChooser(Gtk::Window &parent, Glib::ustring title,
     Glib::ustring default_name);
-    
+  
+  /**
+   * Gets the current name of the chosen in the dialog.
+   * @return Returns the name currently typed into the edit box of the
+   * dialog.
+   **/
   const Glib::ustring get_name() const;
 
 private: