some cleaning :)

[blank.git] / src / app / Runtime.hpp

diff --git a/src/app/Runtime.hpp b/src/app/Runtime.hpp
index 2fdf2e5b0ba2880db1af94f2da8d9560d9db52c8..ee0b4a023737ef1f4d6fea40d7723ab621e10667 100644 (file)
--- a/src/app/Runtime.hpp
+++ b/src/app/Runtime.hpp
@@ -8,14 +8,20 @@
 
 namespace blank {
 
+/// Parse and interpret arguemnts, then set up the environment and execute.
 class Runtime {
 
 public:
        enum Mode {
+               /// default behaviour: run until user quits, dynamic timesteps
                NORMAL,
+               /// quit after n frames
                FRAME_LIMIT,
+               /// quit after n milliseconds
                TIME_LIMIT,
+               /// quit after n frames, use fixed timestap
                FIXED_FRAME_LIMIT,
+               /// display error message and quit with failure
                ERROR,
        };