(svn r12423) [NoAI] -Change: bring a little more uniformness into the first few lines of the API related files (add missing /* $Id$ */ and such). noai
authorrubidium
Wed, 26 Mar 2008 06:06:35 +0000
branchnoai
changeset 9820 8c116d4c6033
parent 9819 fe876b1e5138
child 9821 4ee8e5126dd1
(svn r12423) [NoAI] -Change: bring a little more uniformness into the first few lines of the API related files (add missing /* $Id$ */ and such).
src/ai/api/ai_airport.cpp
src/ai/api/ai_bridgelist.cpp
src/ai/api/ai_cargolist.cpp
src/ai/api/ai_enginelist.cpp
src/ai/api/ai_event.cpp
src/ai/api/ai_event_types.cpp
src/ai/api/ai_industrylist.cpp
src/ai/api/ai_list.cpp
src/ai/api/ai_marine.cpp
src/ai/api/ai_pathfinder_stupid.cpp
src/ai/api/ai_stationlist.cpp
src/ai/api/ai_townlist.cpp
src/ai/api/ai_vehiclelist.cpp
src/ai/api/squirrel_export.awk
--- a/src/ai/api/ai_airport.cpp	Tue Mar 25 23:30:16 2008 +0000
+++ b/src/ai/api/ai_airport.cpp	Wed Mar 26 06:06:35 2008 +0000
@@ -1,5 +1,7 @@
 /* $Id$ */
 
+/** @file ai_airport.cpp handles the functions of the AIAirport class */
+
 #include "ai_airport.hpp"
 #include "../../variables.h"
 #include "../../station_map.h"
--- a/src/ai/api/ai_bridgelist.cpp	Tue Mar 25 23:30:16 2008 +0000
+++ b/src/ai/api/ai_bridgelist.cpp	Wed Mar 26 06:06:35 2008 +0000
@@ -1,3 +1,7 @@
+/* $Id$ */
+
+/** @file ai_bridgelist.cpp List of bridges */
+
 #include "ai_bridgelist.hpp"
 #include "../../bridge.h"
 #include "../../date_func.h"
--- a/src/ai/api/ai_cargolist.cpp	Tue Mar 25 23:30:16 2008 +0000
+++ b/src/ai/api/ai_cargolist.cpp	Wed Mar 26 06:06:35 2008 +0000
@@ -1,3 +1,7 @@
+/* $Id$ */
+
+/** @file ai_cargolist.cpp List of cargos */
+
 #include "ai_cargolist.hpp"
 #include "../../cargotype.h"
 
--- a/src/ai/api/ai_enginelist.cpp	Tue Mar 25 23:30:16 2008 +0000
+++ b/src/ai/api/ai_enginelist.cpp	Wed Mar 26 06:06:35 2008 +0000
@@ -1,3 +1,7 @@
+/* $Id$ */
+
+/** @file ai_enginelist.cpp List of engines */
+
 #include "ai_enginelist.hpp"
 #include "../../engine.h"
 
--- a/src/ai/api/ai_event.cpp	Tue Mar 25 23:30:16 2008 +0000
+++ b/src/ai/api/ai_event.cpp	Wed Mar 26 06:06:35 2008 +0000
@@ -1,3 +1,7 @@
+/* $Id$ */
+
+/** @file ai_event.cpp Handling of in-game events. */
+
 #include "ai_event.hpp"
 /* TODO -- This include has to go */
 #include "ai_event_types.hpp"
--- a/src/ai/api/ai_event_types.cpp	Tue Mar 25 23:30:16 2008 +0000
+++ b/src/ai/api/ai_event_types.cpp	Wed Mar 26 06:06:35 2008 +0000
@@ -1,3 +1,7 @@
+/* $Id$ */
+
+/** @file ai_event_types.cpp The detailed types of all events */
+
 #include "ai_event_types.hpp"
 
 bool AIEventVehicleCrash::CloneCrashedVehicle(TileIndex depot)
--- a/src/ai/api/ai_industrylist.cpp	Tue Mar 25 23:30:16 2008 +0000
+++ b/src/ai/api/ai_industrylist.cpp	Wed Mar 26 06:06:35 2008 +0000
@@ -1,3 +1,7 @@
+/* $Id$ */
+
+/** @file ai_industrylist.cpp List of industries */
+
 #include "ai_industrylist.hpp"
 #include "../../industry.h"
 
--- a/src/ai/api/ai_list.cpp	Tue Mar 25 23:30:16 2008 +0000
+++ b/src/ai/api/ai_list.cpp	Wed Mar 26 06:06:35 2008 +0000
@@ -1,3 +1,7 @@
+/* $Id$ */
+
+/** @file ai_list.cpp A simple list for integral values */
+
 #include "ai_list.hpp"
 
 void AIList::AddItem(int32 item, int32 value)
--- a/src/ai/api/ai_marine.cpp	Tue Mar 25 23:30:16 2008 +0000
+++ b/src/ai/api/ai_marine.cpp	Wed Mar 26 06:06:35 2008 +0000
@@ -1,5 +1,7 @@
 /* $Id$ */
 
+/** @file ai_marine.cpp Everything to query and build marine */
+
 #include "ai_marine.hpp"
 #include "../../command_type.h"
 #include "../../variables.h"
--- a/src/ai/api/ai_pathfinder_stupid.cpp	Tue Mar 25 23:30:16 2008 +0000
+++ b/src/ai/api/ai_pathfinder_stupid.cpp	Wed Mar 26 06:06:35 2008 +0000
@@ -1,5 +1,7 @@
 /* $Id$ */
 
+/** @file ai_pathfinder_stupid.cpp A very stupid pathfinder */
+
 #include "ai_pathfinder_stupid.hpp"
 #include "ai_road.hpp"
 #include "ai_testmode.hpp"
--- a/src/ai/api/ai_stationlist.cpp	Tue Mar 25 23:30:16 2008 +0000
+++ b/src/ai/api/ai_stationlist.cpp	Wed Mar 26 06:06:35 2008 +0000
@@ -1,5 +1,7 @@
 /* $Id$ */
 
+/** @file ai_stationlist.cpp List of stations */
+
 #include "ai_stationlist.hpp"
 #include "ai_vehicle.hpp"
 #include "../../player_func.h"
--- a/src/ai/api/ai_townlist.cpp	Tue Mar 25 23:30:16 2008 +0000
+++ b/src/ai/api/ai_townlist.cpp	Wed Mar 26 06:06:35 2008 +0000
@@ -1,3 +1,7 @@
+/* $Id$ */
+
+/** @file ai_townlist.cpp List of towns */
+
 #include "ai_townlist.hpp"
 #include "../../town.h"
 
--- a/src/ai/api/ai_vehiclelist.cpp	Tue Mar 25 23:30:16 2008 +0000
+++ b/src/ai/api/ai_vehiclelist.cpp	Wed Mar 26 06:06:35 2008 +0000
@@ -1,3 +1,7 @@
+/* $Id$ */
+
+/** @file ai_vehiclelist.cpp List of vehicles */
+
 #include "ai_vehiclelist.hpp"
 #include "ai_station.hpp"
 #include "../../player_func.h"
--- a/src/ai/api/squirrel_export.awk	Tue Mar 25 23:30:16 2008 +0000
+++ b/src/ai/api/squirrel_export.awk	Wed Mar 26 06:06:35 2008 +0000
@@ -1,3 +1,4 @@
+# $Id$
 #
 # Awk script to automatically generate the code needed
 # to export the AI API to Squirrel.