Added missing Doxygen documentation

git-svn-id: svn+ssh://svn.code.sf.net/p/supertuxkart/code/main/trunk@5938 178a84e3-b1eb-0310-8ba1-8eac791a3b58

src/states_screens/dialogs/add_device_dialog.hpp

@@ -22,14 +22,17 @@
 #include "config/player.hpp"
 #include "guiengine/modaldialog.hpp"
 
-
+/**
+  * \brief Dialog that warns the user about the potential problems of
+  *        creating multiple keyboard configs.
+  * \ingroup states_screens
+  */
 class AddDeviceDialog : public GUIEngine::ModalDialog
 {
 public:
-    /**
-     * Creates a modal dialog with given percentage of screen width and height
-     */
+
     AddDeviceDialog();
+    
     void onEnterPressedInternal();
     GUIEngine::EventPropagation processEvent(const std::string& eventSource);
 };

src/states_screens/dialogs/confirm_dialog.hpp

@@ -22,10 +22,18 @@
 #include "config/player.hpp"
 #include "guiengine/modaldialog.hpp"
 
-
+/**
+ * \brief Generic dialog to ask the user to confirm something.
+ * \ingroup states_screens
+ */
 class ConfirmDialog : public GUIEngine::ModalDialog
 {
 public:
+    
+    /**
+     * \brief Listener interface to get notified of whether the user chose to confirm or cancel
+     * \ingroup states_screens
+     */
     class IConfirmDialogListener
     {
     public:
@@ -45,8 +53,14 @@ private:
     
 public:
 
+    /**
+      * \param msg Message to display in the dialog
+      * \param listener A listener object to notify when the user made a choice
+      */
     ConfirmDialog(irr::core::stringw msg, IConfirmDialogListener* listener);
-    void onEnterPressedInternal();
+    
+    virtual void onEnterPressedInternal();
+    
     GUIEngine::EventPropagation processEvent(const std::string& eventSource);
 };
 

src/states_screens/dialogs/confirm_resolution_dialog.hpp

@@ -22,7 +22,11 @@
 #include "config/player.hpp"
 #include "guiengine/modaldialog.hpp"
 
-
+/**
+ * \brief Dialog shown after a resolution switch sot he user may confirm if
+ *        the resolution works.
+ * \ingroup states_screens
+ */
 class ConfirmResolutionDialog : public GUIEngine::ModalDialog
 {
     /** number of seconds left before resolution is considered unplayable */

src/states_screens/dialogs/enter_player_name_dialog.hpp

@@ -28,11 +28,12 @@ namespace GUIEngine
     class LabelWidget;
 }
 
+/**
+ * \brief Dialog that allows the player to enter the name for a new player
+ * \ingroup states_screens
+ */
 class EnterPlayerNameDialog : public GUIEngine::ModalDialog
 {
-    //GUIEngine::LabelWidget*   m_label_ctrl;
-    //GUIEngine::TextBoxWidget* textCtrl;
-    //GUIEngine::ButtonWidget*  cancelButton;
     
 public:
     /**

src/states_screens/dialogs/gp_info_dialog.hpp

@@ -26,6 +26,10 @@ namespace GUIEngine
     class IconButtonWidget;
 }
 
+/**
+ * \brief Dialog that shows information about a specific grand prix
+ * \ingroup states_screens
+ */
 class GPInfoDialog : public GUIEngine::ModalDialog
 {
     std::string m_gp_ident;

src/states_screens/dialogs/player_info_dialog.hpp

@@ -27,6 +27,10 @@ namespace GUIEngine
     class TextBoxWidget;
 }
 
+/**
+ * \brief Dialog that allows renaming and deleting players
+ * \ingroup states_screens
+ */
 class PlayerInfoDialog : public GUIEngine::ModalDialog
 {
     GUIEngine::TextBoxWidget* textCtrl;

src/states_screens/dialogs/press_a_key_dialog.hpp

@@ -21,6 +21,10 @@
 
 #include "guiengine/modaldialog.hpp"
 
+/**
+ * \brief Dialog shown when editing input bindings and it's time to press a key
+ * \ingroup states_screens
+ */
 class PressAKeyDialog : public GUIEngine::ModalDialog
 {
 public:

src/states_screens/dialogs/race_paused_dialog.hpp

@@ -25,9 +25,12 @@ namespace GUIEngine
     class RibbonWidget;
 }
 
+/**
+ * \brief Dialog shown when the race is paused
+ * \ingroup states_screens
+ */
 class RacePausedDialog : public GUIEngine::ModalDialog
 {
-    //GUIEngine::RibbonWidget* m_choice_ribbon;
     
 protected:
     virtual void loadedFromFile();

src/states_screens/dialogs/track_info_dialog.hpp

@@ -26,6 +26,10 @@ static const int HIGHSCORE_COUNT = 3;
 
 namespace irr { namespace gui { class IGUIImage; class IGUIStaticText; } }
 
+/**
+ * \brief Dialog that shows the information about a given track
+ * \ingroup states_screens
+ */
 class TrackInfoDialog : public GUIEngine::ModalDialog
 {
     std::string m_track_ident;