removed useless comments

[l2e.git] / src / app / Application.h

diff --git a/src/app/Application.h b/src/app/Application.h
index 41198bce88c4f2e4f5ca1a7c07c8af9c713d9c8b..817f79fd2217499cd470c04eb22e1ff6755f91f9 100644 (file)
--- a/src/app/Application.h
+++ b/src/app/Application.h
@@ -1,17 +1,15 @@
-/*
- * Application.h
- *
- *  Created on: Apr 8, 2012
- *      Author: holy
- */
-
 #ifndef APP_APPLICATION_H_
 #define APP_APPLICATION_H_
 
-#include "fwd.h"
+namespace app {
+       class State;
+}
+namespace sdl {
+       class InitScreen;
+}
+
 #include "Input.h"
 #include "Timer.h"
-#include "../sdl/InitScreen.h"
 
 #include <stack>
 #include <queue>
@@ -20,10 +18,23 @@
 
 namespace app {
 
+/// Application controller class.
+/// Operates on a state stack that can be modified via ChangeState, PushState,
+/// and PopState.
+/// All state changes are delayed until the looping mechanism gets control again
+/// (i.e. after a top level state function returns, not during).
+/// SDL key events are preprocessed, see app::Input.
+/// The quit event (typically window closed or signal received) is caught and
+/// results in immediate (that is, after the next input loop) termination.
+/// Popped states will be deleted via the plain delete operator on an app::State
+/// pointer.
+/// Timers created by GlobalTimers() operate on actual application time and are
+/// not paused when the current state is paused (as are the timers started by
+/// the app::State members).
 class Application {
 
 public:
-       Application(sdl::InitScreen *screen, State *initialState);
+       Application(sdl::InitScreen &screen, State *initialState);
        ~Application();
 private:
        Application(const Application &);
@@ -65,7 +76,7 @@ private:
        void Render();
 
 private:
-       sdl::InitScreen *screen;
+       sdl::InitScreen &screen;
        std::stack<State *> states;
        std::queue<StateCommand> stateChanges;
        Timers<Uint32> globalTimers;
@@ -77,4 +88,4 @@ private:
 
 }
 
-#endif /* APP_APPLICATION_H_ */
+#endif