[Pingus-CVS] r3643 - trunk/pingus/src

[grumbel at BerliOS]

Author: grumbel
Date: 2008-07-03 21:40:44 +0200 (Thu, 03 Jul 2008)
New Revision: 3643

Modified:
   trunk/pingus/src/server_event.hpp
Log:
Some more documentation

Modified: trunk/pingus/src/server_event.hpp
===================================================================
--- trunk/pingus/src/server_event.hpp   2008-07-03 04:27:26 UTC (rev 3642)
+++ trunk/pingus/src/server_event.hpp   2008-07-03 19:40:44 UTC (rev 3643)
@@ -64,9 +64,21 @@
   void send(Server*);
 
   // Pseudo constructors
+
+  /** The end event marks the very end of the demo, i.e. the time the
+      server did run its last update() */
   static ServerEvent make_end_event(int time);
+
+  /** The finish event is triggered when the user leave the level by
+      pressing escape */
   static ServerEvent make_finish_event(int time);
+
+  /** The armageddon event is triggered when the user presses the
+      armageddon button */
   static ServerEvent make_armageddon_event(int time);
+
+  /** The pingu action event is triggered whenever the user applies an
+      action to a Pingu */
   static ServerEvent make_pingu_action_event(int t, int id, const Vector3f& 
pos, Actions::ActionName action);
 };