(svn r12496) [NoAI] -Documentation: give the .cpp files a nice uniform format too
[NoAI] -Fix: fixed the last missing $Id$ and propset
--- a/src/ai/api/ai_abstractlist.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_abstractlist.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_abstractlist.cpp Implementation of AIAbstractList */
+/** @file ai_abstractlist.cpp Implementation of AIAbstractList. */
#include <squirrel.h>
#include "ai_abstractlist.hpp"
--- a/src/ai/api/ai_accounting.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_accounting.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_accounting.cpp everything to handle AI accounting things */
+/** @file ai_accounting.cpp Implementation of AIAccounting. */
#include "ai_accounting.hpp"
--- a/src/ai/api/ai_airport.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_airport.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_airport.cpp handles the functions of the AIAirport class */
+/** @file ai_airport.cpp Implementation of AIAirport. */
#include "ai_airport.hpp"
#include "../../variables.h"
--- a/src/ai/api/ai_base.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_base.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_base.cpp handles the functions of the AIBase class */
+/** @file ai_base.cpp Implementation of AIBase. */
#include "ai_base.hpp"
#include "../../network/network.h"
--- a/src/ai/api/ai_bridge.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_bridge.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_bridge.cpp handles the functions of the AIBridge class */
+/** @file ai_bridge.cpp Implementation of AIBridge. */
#include "ai_bridge.hpp"
#include "../../bridge.h"
--- a/src/ai/api/ai_bridgelist.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_bridgelist.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_bridgelist.cpp List of bridges */
+/** @file ai_bridgelist.cpp Implementation of AIBridgeList and friends. */
#include "ai_bridgelist.hpp"
#include "../../bridge.h"
--- a/src/ai/api/ai_cargo.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_cargo.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_cargo.cpp handles the query-related of the AICargo class */
+/** @file ai_cargo.cpp Implementation of AICargo. */
#include "ai_cargo.hpp"
#include "../../cargotype.h"
--- a/src/ai/api/ai_cargolist.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_cargolist.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_cargolist.cpp List of cargos */
+/** @file ai_cargolist.cpp Implementation of AICargoList and friends. */
#include "ai_cargolist.hpp"
#include "../../cargotype.h"
--- a/src/ai/api/ai_company.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_company.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_company.cpp handles the functions of the AICompany class */
+/** @file ai_company.cpp Implementation of AICompany. */
#include "ai_company.hpp"
#include "../../command_func.h"
--- a/src/ai/api/ai_controller.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_controller.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_controller.cpp handles the functions of the AIControler class */
+/** @file ai_controller.cpp Implementation of AIControler. */
#include "ai_controller.hpp"
#include "../../stdafx.h"
--- a/src/ai/api/ai_date.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_date.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_date.cpp handles the functions of the AIDate class */
+/** @file ai_date.cpp Implementation of AIDate. */
#include "ai_date.hpp"
#include "../../date_func.h"
--- a/src/ai/api/ai_engine.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_engine.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_engine.cpp handles the functions of the AIEngine class */
+/** @file ai_engine.cpp Implementation of AIEngine. */
#include "ai_engine.hpp"
#include "ai_cargo.hpp"
--- a/src/ai/api/ai_enginelist.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_enginelist.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_enginelist.cpp List of engines */
+/** @file ai_enginelist.cpp Implementation of AIEngineList and friends. */
#include "ai_enginelist.hpp"
#include "../../engine.h"
--- a/src/ai/api/ai_event.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_event.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_event.cpp Handling of in-game events. */
+/** @file ai_event.cpp Implementation of AIEvent. */
#include "ai_event.hpp"
/* TODO -- This include has to go */
--- a/src/ai/api/ai_event_types.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_event_types.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_event_types.cpp The detailed types of all events */
+/** @file ai_event_types.cpp Implementation of all EventTypes. */
#include "ai_event_types.hpp"
--- a/src/ai/api/ai_execmode.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_execmode.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_execmode.cpp class to switch the AI to Execute mode */
+/** @file ai_execmode.cpp Implementation of AIExecMode. */
#include "ai_execmode.hpp"
--- a/src/ai/api/ai_industry.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_industry.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_industry.cpp handles the query-related of the AIIndustry class */
+/** @file ai_industry.cpp Implementation of AIIndustry. */
#include "ai_industry.hpp"
#include "ai_cargo.hpp"
--- a/src/ai/api/ai_industrylist.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_industrylist.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_industrylist.cpp List of industries */
+/** @file ai_industrylist.cpp Implementation of AIIndustryList and friends. */
#include "ai_industrylist.hpp"
#include "../../industry.h"
--- a/src/ai/api/ai_list.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_list.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_list.cpp A simple list for integral values */
+/** @file ai_list.cpp Implementation of AIList. */
#include "ai_list.hpp"
--- a/src/ai/api/ai_map.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_map.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_map.cpp handles the query-related of the AIMap class */
+/** @file ai_map.cpp Implementation of AIMap. */
#include "ai_map.hpp"
#include "../../command_type.h"
--- a/src/ai/api/ai_marine.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_marine.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_marine.cpp Everything to query and build marine */
+/** @file ai_marine.cpp Implementation of AIMarine. */
#include "ai_marine.hpp"
#include "../../command_type.h"
--- a/src/ai/api/ai_object.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_object.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_object.cpp handles the commands-related functions of the AIObject class */
+/** @file ai_object.cpp Implementation of AIObject. */
#include "ai_object.hpp"
#include "../../command_func.h"
--- a/src/ai/api/ai_order.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_order.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_order.cpp handles the functions of the AIOrder class */
+/** @file ai_order.cpp Implementation of AIOrder. */
#include "ai_order.hpp"
#include "ai_map.hpp"
--- a/src/ai/api/ai_road.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_road.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_road.cpp handles the functions of the AIRoad class */
+/** @file ai_road.cpp Implementation of AIRoad. */
#include "ai_road.hpp"
#include "../../road_map.h"
--- a/src/ai/api/ai_settings.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_settings.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_settings.cpp everything to change AI settings */
+/** @file ai_settings.cpp Implementation of AISettings. */
#include "ai_settings.hpp"
--- a/src/ai/api/ai_sign.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_sign.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_sign.cpp handles all functions of the AISign class */
+/** @file ai_sign.cpp Implementation of AISign. */
#include "ai_sign.hpp"
#include "table/strings.h"
--- a/src/ai/api/ai_station.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_station.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_station.cpp handles the functions of the AIStation class */
+/** @file ai_station.cpp Implementation of AIStation. */
#include "ai_station.hpp"
#include "ai_cargo.hpp"
--- a/src/ai/api/ai_stationlist.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_stationlist.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_stationlist.cpp List of stations */
+/** @file ai_stationlist.cpp Implementation of AIStationList and friends. */
#include "ai_stationlist.hpp"
#include "ai_vehicle.hpp"
--- a/src/ai/api/ai_testmode.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_testmode.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_testmode.cpp class to switch the AI to Testing mode */
+/** @file ai_testmode.cpp Implementation of AITestMode. */
#include "ai_testmode.hpp"
--- a/src/ai/api/ai_tile.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_tile.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_tile.cpp handles the functions of the AITile class */
+/** @file ai_tile.cpp Implementation of AITile. */
#include "ai_tile.hpp"
#include "ai_map.hpp"
--- a/src/ai/api/ai_tilelist.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_tilelist.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_tilelist.cpp handles all functions of the AITileList class */
+/** @file ai_tilelist.cpp Implementation of AITileList and friends. */
#include "ai_tilelist.hpp"
#include "ai_industry.hpp"
--- a/src/ai/api/ai_town.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_town.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_town.cpp handles the town-related functions of the AITown class */
+/** @file ai_town.cpp Implementation of AITown. */
#include "ai_town.hpp"
#include "ai_map.hpp"
--- a/src/ai/api/ai_townlist.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_townlist.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_townlist.cpp List of towns */
+/** @file ai_townlist.cpp Implementation of AITownList and friends. */
#include "ai_townlist.hpp"
#include "../../town.h"
--- a/src/ai/api/ai_transactionmode.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_transactionmode.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_transactionmode.cpp class to switch the AI to Transaction mode */
+/** @file ai_transactionmode.cpp Implementation of AITransactionMode. */
#include "ai_transactionmode.hpp"
#include "ai_execmode.hpp"
--- a/src/ai/api/ai_tunnel.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_tunnel.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,4 +1,6 @@
-/** @file ai_tunnel.cpp handles the query-related of the AITunnel class and can construct tunnels **/
+/* $Id$ */
+
+/** @file ai_tunnel.cpp Implementation of AITunnel. */
#include "ai_tunnel.hpp"
#include "ai_map.hpp"
--- a/src/ai/api/ai_vehicle.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_vehicle.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_vehicle.cpp handles the functions of the AIVehicle class */
+/** @file ai_vehicle.cpp Implementation of AIVehicle. */
#include "ai_vehicle.hpp"
#include "ai_engine.hpp"
--- a/src/ai/api/ai_vehiclelist.cpp Mon Mar 31 06:37:24 2008 +0000
+++ b/src/ai/api/ai_vehiclelist.cpp Mon Mar 31 06:45:57 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ai_vehiclelist.cpp List of vehicles */
+/** @file ai_vehiclelist.cpp Implementation of AIVehicleList and friends. */
#include "ai_vehiclelist.hpp"
#include "ai_station.hpp"