src/ai/api/ai_event_types.hpp
branchnoai
changeset 9829 80fbe02a4184
parent 9824 2c2a5a27c4eb
child 9843 29f34a179daf
--- a/src/ai/api/ai_event_types.hpp	Sun Mar 30 20:58:41 2008 +0000
+++ b/src/ai/api/ai_event_types.hpp	Mon Mar 31 06:32:27 2008 +0000
@@ -1,6 +1,6 @@
 /* $Id$ */
 
-/** @file ai_event_types.hpp The detailed types of all events */
+/** @file ai_event_types.hpp The detailed types of all events. */
 
 #ifndef AI_EVENT_TYPES_HPP
 #define AI_EVENT_TYPES_HPP
@@ -11,8 +11,8 @@
 #include "ai_industry.hpp"
 
 /**
- * A simple test event, to see if the event system is working. Triggered via
- *  AIEventController::Test();
+ * Event Test: a simple test event, to see if the event system is working.
+ *  Triggered via AIEventController::Test();
  */
 class AIEventTest : public AIEvent {
 public:
@@ -41,7 +41,7 @@
 };
 
 /**
- * A vehicle crashed, and because of that this event is triggered.
+ * Event Vehicle Crash, indicating a vehicle of yours is crashed.
  *  It contains both the crash site as the vehicle crashed. It has a nice
  *  helper that creates a new vehicle in a depot with the same type
  *  and orders as the crashed one. In case the vehicle type isn't available
@@ -89,9 +89,10 @@
 };
 
 /**
- * A subsidiary is offered. You can get the type of cargo the subsidiary is
- *  for, if it is between towns or industry, and from where to where (which
- *  is either in TownID or IndustryID).
+ * Event Subsidiary Offered, indicating someone offered a subsidiary.
+ *  You can get the type of cargo the subsidiary is for, if it is between
+ *  towns or industry, and from where to where (which is either in TownID
+ *  or IndustryID).
  */
 class AIEventSubsidiaryOffer : public AIEvent {
 public: