QTfrontend/SDLs.h
changeset 6164 62aa418ed214
parent 4976 088d40d8aba2
--- a/QTfrontend/SDLs.h	Fri Oct 21 01:47:53 2011 +0200
+++ b/QTfrontend/SDLs.h	Fri Oct 21 04:11:26 2011 +0200
@@ -23,7 +23,7 @@
 #include <QStringList>
 #include "SDL_mixer.h"
 
-
+/// Class for interacting with SDL (used for music and keys)
 class SDLInteraction : public QObject
 {
     Q_OBJECT
@@ -33,12 +33,29 @@
     int musicInitialized;
 
 public:
+    /// Class Constructor.
     SDLInteraction();
+
+    /// Class Destructor.
     ~SDLInteraction();
+
+    /**
+     * @brief Returns available (screen) resolutions.
+     *
+     * @return list of resolutions in the format WIDTHxHEIGHT.
+     */
     QStringList getResolutions() const;
+
+    /// Adds all available joystick controlls to the list of SDL keys.
     void addGameControllerKeys() const;
+
+    /// Starts the background music.
     void StartMusic();
+
+    /// Fades out and stops the background music.
     void StopMusic();
+
+    /// Initializes SDL for playing music.
     void SDLMusicInit();
 };