(svn r12971) -Documentation: add @file in files that missed them and add something more than whitespace as description of files that don't have a description.
--- a/Doxyfile Tue May 06 15:06:19 2008 +0000
+++ b/Doxyfile Tue May 06 15:11:33 2008 +0000
@@ -76,7 +76,7 @@
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
-INPUT = ./
+INPUT = ./src/
FILE_PATTERNS = *.c \
*.cc \
*.cxx \
--- a/src/ai/ai.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/ai/ai.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file ai.cpp Base for all AIs. */
+
#include "../stdafx.h"
#include "../openttd.h"
#include "../variables.h"
--- a/src/ai/ai.h Tue May 06 15:06:19 2008 +0000
+++ b/src/ai/ai.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file ai.h Base functions for all AIs. */
+
#ifndef AI_H
#define AI_H
--- a/src/ai/default/default.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/ai/default/default.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file default.cpp The original AI. */
+
#include "../../stdafx.h"
#include "../../openttd.h"
#include "../../aircraft.h"
--- a/src/ai/default/default.h Tue May 06 15:06:19 2008 +0000
+++ b/src/ai/default/default.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file default.h The original AI. */
+
#ifndef DEFAULT_H
#define DEFAULT_H
--- a/src/ai/trolly/build.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/ai/trolly/build.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file build.cpp Building support for the trolly AI. */
+
#include "../../stdafx.h"
#include "../../openttd.h"
#include "../../debug.h"
--- a/src/ai/trolly/pathfinder.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/ai/trolly/pathfinder.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file pathfinder.cpp Pathfinder support for the trolly AI. */
+
#include "../../stdafx.h"
#include "../../openttd.h"
#include "../../bridge_map.h"
--- a/src/ai/trolly/shared.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/ai/trolly/shared.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file shared.cpp Shared functions for the trolly AI. */
+
#include "../../stdafx.h"
#include "../../openttd.h"
#include "../../debug.h"
--- a/src/ai/trolly/trolly.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/ai/trolly/trolly.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,8 @@
/* $Id$ */
-/*
+/**
+ * @file trolly.cpp Implementation of the trolly AI.
+ *
* This AI was created as a direct reaction to the big demand for some good AIs
* in OTTD. Too bad it never left alpha-stage, and it is considered dead in its
* current form.
--- a/src/ai/trolly/trolly.h Tue May 06 15:06:19 2008 +0000
+++ b/src/ai/trolly/trolly.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file trolly.h Functions/defines related to the trolly AI. */
+
#ifndef AI_TROLLY_H
#define AI_TROLLY_H
--- a/src/aircraft.h Tue May 06 15:06:19 2008 +0000
+++ b/src/aircraft.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file aircraft.h */
+/** @file aircraft.h Base for aircraft. */
#ifndef AIRCRAFT_H
#define AIRCRAFT_H
--- a/src/aircraft_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/aircraft_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file aircraft_gui.cpp */
+/** @file aircraft_gui.cpp The GUI of aircraft. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/airport.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/airport.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file airport.cpp */
+/** @file airport.cpp Functions related to airports. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/airport_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/airport_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file airport_gui.cpp */
+/** @file airport_gui.cpp The GUI for airports. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/animated_tile_func.h Tue May 06 15:06:19 2008 +0000
+++ b/src/animated_tile_func.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file animated_tile.h Tile animation! */
+/** @file animated_tile_func.h Tile animation! */
#ifndef ANIMATED_TILE_H
#define ANIMATED_TILE_H
--- a/src/articulated_vehicles.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/articulated_vehicles.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file articulated_vehicles.cpp */
+/** @file articulated_vehicles.cpp Implementation of articulated vehicles. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/articulated_vehicles.h Tue May 06 15:06:19 2008 +0000
+++ b/src/articulated_vehicles.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file articulated_vehicles.h */
+/** @file articulated_vehicles.h Functions related to articulated vehicles. */
#ifndef ARTICULATED_VEHICLES_H
#define ARTICULATED_VEHICLES_H
--- a/src/autoreplace_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/autoreplace_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file autoreplace_gui.cpp */
+/** @file autoreplace_gui.cpp GUI for autoreplace handling. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/autoslope.h Tue May 06 15:06:19 2008 +0000
+++ b/src/autoslope.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file autoslope.h */
+/** @file autoslope.h Functions related to autoslope. */
#ifndef AUTOSLOPE_H
#define AUTOSLOPE_H
--- a/src/aystar.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/aystar.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file aystar.cpp */
+/** @file aystar.cpp Implementation of A*. */
/*
* This file has the core function for AyStar
--- a/src/blitter/32bpp_anim.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/blitter/32bpp_anim.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file 32bpp_anim.cpp Implementation of the optimized 32 bpp blitter with animation support. */
+
#include "../stdafx.h"
#include "../core/alloc_func.hpp"
#include "../gfx_func.h"
--- a/src/blitter/32bpp_anim.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/blitter/32bpp_anim.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 32bpp_anim.hpp */
+/** @file 32bpp_anim.hpp A 32 bpp blitter with animation support. */
#ifndef BLITTER_32BPP_ANIM_HPP
#define BLITTER_32BPP_ANIM_HPP
--- a/src/blitter/32bpp_base.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/blitter/32bpp_base.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file 32bpp_base.cpp Implementation of base for 32 bpp blitters. */
+
#include "../stdafx.h"
#include "../gfx_func.h"
#include "32bpp_base.hpp"
--- a/src/blitter/32bpp_base.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/blitter/32bpp_base.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 32bpp_base.hpp */
+/** @file 32bpp_base.hpp Base for all 32 bits blitters. */
#ifndef BLITTER_32BPP_BASE_HPP
#define BLITTER_32BPP_BASE_HPP
--- a/src/blitter/32bpp_optimized.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/blitter/32bpp_optimized.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file 32bpp_optimized.cpp Implementation of the optimized 32 bpp blitter. */
+
#include "../stdafx.h"
#include "../zoom_func.h"
#include "../gfx_func.h"
--- a/src/blitter/32bpp_optimized.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/blitter/32bpp_optimized.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 32bpp_optimized.hpp */
+/** @file 32bpp_optimized.hpp Optimized 32 bpp blitter. */
#ifndef BLITTER_32BPP_OPTIMIZED_HPP
#define BLITTER_32BPP_OPTIMIZED_HPP
--- a/src/blitter/32bpp_simple.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/blitter/32bpp_simple.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file 32bpp_simple.cpp Implementation of the simple 32 bpp blitter. */
+
#include "../stdafx.h"
#include "../gfx_func.h"
#include "../zoom_func.h"
--- a/src/blitter/32bpp_simple.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/blitter/32bpp_simple.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 32bpp_simple.hpp */
+/** @file 32bpp_simple.hpp Simple 32 bpp blitter. */
#ifndef BLITTER_32BPP_SIMPLE_HPP
#define BLITTER_32BPP_SIMPLE_HPP
--- a/src/blitter/8bpp_base.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/blitter/8bpp_base.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file 8bpp_base.cpp Implementation of the base for all 8 bpp blitters. */
+
#include "../stdafx.h"
#include "../gfx_func.h"
#include "8bpp_base.hpp"
--- a/src/blitter/8bpp_base.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/blitter/8bpp_base.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 8bpp_base.hpp */
+/** @file 8bpp_base.hpp Base for all 8 bpp blitters. */
#ifndef BLITTER_8BPP_BASE_HPP
#define BLITTER_8BPP_BASE_HPP
--- a/src/blitter/8bpp_debug.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/blitter/8bpp_debug.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 8bpp_debug.cpp */
+/** @file 8bpp_debug.cpp Implementation of 8 bpp debug blitter. */
#include "../stdafx.h"
#include "../zoom_func.h"
--- a/src/blitter/8bpp_debug.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/blitter/8bpp_debug.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 8bpp_debug.hpp */
+/** @file 8bpp_debug.hpp A 8 bpp blitter that uses random colours to show the drawn sprites. */
#ifndef BLITTER_8BPP_DEBUG_HPP
#define BLITTER_8BPP_DEBUG_HPP
--- a/src/blitter/8bpp_optimized.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/blitter/8bpp_optimized.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 8bpp_optimized.cpp */
+/** @file 8bpp_optimized.cpp Implementation of the optimized 8 bpp blitter. */
#include "../stdafx.h"
#include "../zoom_func.h"
--- a/src/blitter/8bpp_optimized.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/blitter/8bpp_optimized.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 8bpp_optimized.hpp */
+/** @file 8bpp_optimized.hpp An optimized 8 bpp blitter. */
#ifndef BLITTER_8BPP_OPTIMIZED_HPP
#define BLITTER_8BPP_OPTIMIZED_HPP
--- a/src/blitter/8bpp_simple.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/blitter/8bpp_simple.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 8bpp_simple.cpp */
+/** @file 8bpp_simple.cpp Implementation of the simple 8 bpp blitter. */
#include "../stdafx.h"
#include "../zoom_func.h"
--- a/src/blitter/8bpp_simple.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/blitter/8bpp_simple.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file 8bpp_simple.hpp */
+/** @file 8bpp_simple.hpp Simple (and slow) 8 bpp blitter. */
#ifndef BLITTER_8BPP_SIMPLE_HPP
#define BLITTER_8BPP_SIMPLE_HPP
--- a/src/blitter/base.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/blitter/base.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file base.hpp Base for all blitters. */
+
#ifndef BLITTER_BASE_HPP
#define BLITTER_BASE_HPP
--- a/src/blitter/factory.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/blitter/factory.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file factory.hpp Factory to 'query' all available blitters. */
+
#ifndef BLITTER_FACTORY_HPP
#define BLITTER_FACTORY_HPP
--- a/src/blitter/null.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/blitter/null.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file null.hpp */
+/** @file null.hpp The blitter that doesn't blit. */
#ifndef BLITTER_NULL_HPP
#define BLITTER_NULL_HPP
--- a/src/bmp.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/bmp.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file bmp.cpp */
+/** @file bmp.cpp Read and write support for bmps. */
#include "stdafx.h"
#include "bmp.h"
--- a/src/bmp.h Tue May 06 15:06:19 2008 +0000
+++ b/src/bmp.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file bmp.h */
+/** @file bmp.h Read and write support for bmps. */
#ifndef BMP_H
#define BMP_H
--- a/src/build_vehicle_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/build_vehicle_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file build_vehicle_gui.cpp */
+/** @file build_vehicle_gui.cpp GUI for building vehicles. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/callback_table.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/callback_table.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file callback_table.cpp */
+/** @file callback_table.cpp All command callbacks. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/callback_table.h Tue May 06 15:06:19 2008 +0000
+++ b/src/callback_table.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file callback_table.h */
+/** @file callback_table.h Table with all command callbacks. */
#ifndef CALLBACK_TABLE_H
#define CALLBACK_TABLE_H
--- a/src/cargopacket.h Tue May 06 15:06:19 2008 +0000
+++ b/src/cargopacket.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file cargopacket.h */
+/** @file cargopacket.h Base class for cargo packets. */
#ifndef CARGOPACKET_H
#define CARGOPACKET_H
--- a/src/cargotype.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/cargotype.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file cargotype.cpp */
+/** @file cargotype.cpp Implementation of cargos. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/cargotype.h Tue May 06 15:06:19 2008 +0000
+++ b/src/cargotype.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file cargotype.h */
+/** @file cargotype.h Types/functions related to cargos. */
#ifndef CARGOTYPE_H
#define CARGOTYPE_H
--- a/src/cheat.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/cheat.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file misc.cpp */
+/** @file cheat.cpp Handling (loading/saving/initializing) of cheats. */
#include "stdafx.h"
#include "saveload.h"
--- a/src/cheat_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/cheat_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file misc_gui.cpp */
+/** @file cheat_gui.cpp GUI related to cheating. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/clear_cmd.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/clear_cmd.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file clear_cmd.cpp */
+/** @file clear_cmd.cpp Commands related to clear tiles. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/cmd_helper.h Tue May 06 15:06:19 2008 +0000
+++ b/src/cmd_helper.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file cmd_helper.h Helper functions to extract data from command parameters. */
+
#ifndef CMD_HELPER_H
#define CMD_HELPER_H
--- a/src/command.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/command.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file command.cpp */
+/** @file command.cpp Handling of commands. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/console.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/console.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file console.cpp */
+/** @file console.cpp Handling of the in-game console. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/console.h Tue May 06 15:06:19 2008 +0000
+++ b/src/console.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file console.h */
+/** @file console.h In-game console. */
#ifndef CONSOLE_H
#define CONSOLE_H
--- a/src/console_cmds.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/console_cmds.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file console_cmds.cpp */
+/** @file console_cmds.cpp Implementation of the console hooks. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/core/alloc_func.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/core/alloc_func.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file alloc_func.cpp functions to 'handle' memory allocation errors */
+/** @file alloc_func.cpp Functions to 'handle' memory allocation errors */
#include "../stdafx.h"
#include "alloc_func.hpp"
--- a/src/core/alloc_type.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/core/alloc_type.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,4 +1,3 @@
-
/* $Id$ */
/** @file alloc_type.hpp Helper types related to the allocation of memory */
--- a/src/core/bitmath_func.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/core/bitmath_func.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file bitmath_func.cpp */
+/** @file bitmath_func.cpp Functions related to bit mathematics. */
#include "../stdafx.h"
#include "bitmath_func.hpp"
--- a/src/core/bitmath_func.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/core/bitmath_func.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file bitmath_func.hpp */
+/** @file bitmath_func.hpp Functions related to bit mathematics. */
#ifndef BITMATH_FUNC_HPP
#define BITMATH_FUNC_HPP
--- a/src/core/endian_func.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/core/endian_func.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file endian_func.hpp */
+/** @file endian_func.hpp Function to handling different endian machines. */
#ifndef ENDIAN_FUNC_H
#define ENDIAN_FUNC_H
--- a/src/core/random_func.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/core/random_func.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file random_func.cpp */
+/** @file random_func.cpp Implementation of the pseudo random generator. */
#include "../stdafx.h"
#include "random_func.hpp"
--- a/src/core/random_func.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/core/random_func.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file random_func.hpp */
+/** @file random_func.hpp Pseudo random number generator. */
#ifndef RANDOM_FUNC_HPP
#define RANDOM_FUNC_HPP
--- a/src/currency.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/currency.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file currency.cpp **/
+/** @file currency.cpp Support for different currencies. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/currency.h Tue May 06 15:06:19 2008 +0000
+++ b/src/currency.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file currency.h */
+/** @file currency.h Functions to handle different currencies. */
#ifndef CURRENCY_H
#define CURRENCY_H
--- a/src/date.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/date.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file date.cpp */
+/** @file date.cpp Handling of dates in our native format and transforming them to something human readable. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/debug.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/debug.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file debug.cpp */
+/** @file debug.cpp Handling of printing debug messages. */
#include "stdafx.h"
#include <stdio.h>
--- a/src/debug.h Tue May 06 15:06:19 2008 +0000
+++ b/src/debug.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file debug.h */
+/** @file debug.h Functions related to debugging. */
#ifndef DEBUG_H
#define DEBUG_H
--- a/src/dedicated.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/dedicated.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file dedicated.cpp */
+/** @file dedicated.cpp Forking support for dedicated servers. */
#include "stdafx.h"
--- a/src/depot.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/depot.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file depot.cpp */
+/** @file depot.cpp Handling of depots. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/depot_base.h Tue May 06 15:06:19 2008 +0000
+++ b/src/depot_base.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file depot.h Base for all depots (except hangars) */
+/** @file depot_base.h Base for all depots (except hangars) */
#ifndef DEPOT_BASE_H
#define DEPOT_BASE_H
--- a/src/depot_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/depot_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file depot_gui.cpp */
+/** @file depot_gui.cpp The GUI for depots. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/dock_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/dock_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file dock_gui.cpp */
+/** @file dock_gui.cpp GUI to create amazing water objects. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/driver.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/driver.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file driver.cpp */
+/** @file driver.cpp Base for all driver handling. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/driver.h Tue May 06 15:06:19 2008 +0000
+++ b/src/driver.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file driver.h */
+/** @file driver.h Base for all drivers (video, sound, music, etc). */
#ifndef DRIVER_H
#define DRIVER_H
--- a/src/dummy_land.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/dummy_land.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file dummy_land.cpp */
+/** @file dummy_land.cpp Handling of void (or dummy) tiles. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/economy.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/economy.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file economy.cpp */
+/** @file economy.cpp Handling of the economy. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/effectvehicle.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/effectvehicle.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file vehicle.cpp */
+/** @file effectvehicle.cpp Implementation of everything generic to vehicles. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/effectvehicle_func.h Tue May 06 15:06:19 2008 +0000
+++ b/src/effectvehicle_func.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file effectvehicle.h Functions related to effect vehicles. */
+/** @file effectvehicle_func.h Functions related to effect vehicles. */
#ifndef EFFECTVEHICLE_FUNC_H
#define EFFECTVEHICLE_FUNC_H
--- a/src/elrail.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/elrail.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,4 +1,5 @@
/* $Id$ */
+
/** @file elrail.cpp
* This file deals with displaying wires and pylons for electric railways.
* <h2>Basics</h2>
--- a/src/engine.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/engine.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file engine.cpp */
+/** @file engine.cpp Base for all engine handling. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/engine_func.h Tue May 06 15:06:19 2008 +0000
+++ b/src/engine_func.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file engine_func.h */
+/** @file engine_func.h Functions related to engines. */
#ifndef ENGINE_H
#define ENGINE_H
--- a/src/engine_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/engine_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file engine_gui.cpp */
+/** @file engine_gui.cpp GUI to show engine related information. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/fiber.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/fiber.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file fiber.hpp */
+/** @file fiber.hpp Base for all fiber related classes. */
#ifndef FIBER_HPP
#define FIBER_HPP
--- a/src/fontcache.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/fontcache.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file fontcache.cpp */
+/** @file fontcache.cpp Cache for characters from fonts. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/fontcache.h Tue May 06 15:06:19 2008 +0000
+++ b/src/fontcache.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file fontcache.h Functions to read fonts from files and cache them. */
+
#ifndef FONTCACHE_H
#define FONTCACHE_H
--- a/src/functions.h Tue May 06 15:06:19 2008 +0000
+++ b/src/functions.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file functions.h */
+/** @file functions.h Some generic functions that actually shouldn't be here. */
#ifndef FUNCTIONS_H
#define FUNCTIONS_H
--- a/src/genworld.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/genworld.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file genworld.cpp */
+/** @file genworld.cpp Functions to generate a map. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/genworld.h Tue May 06 15:06:19 2008 +0000
+++ b/src/genworld.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file genworld.h */
+/** @file genworld.h Functions related to world/map generation. */
#ifndef GENWORLD_H
#define GENWORLD_H
--- a/src/genworld_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/genworld_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file genworld_gui.cpp */
+/** @file genworld_gui.cpp GUI to configure and show progress during map generation. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/gfx.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/gfx.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file gfx.cpp */
+/** @file gfx.cpp Handling of drawing text and other gfx related stuff. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/gfxinit.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/gfxinit.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file gfxinit.cpp */
+/** @file gfxinit.cpp Initializing of the (GRF) graphics. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/gfxinit.h Tue May 06 15:06:19 2008 +0000
+++ b/src/gfxinit.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file gfxinit.h */
+/** @file gfxinit.h Functions related to the graphics initialization. */
#ifndef GFXINIT_H
#define GFXINIT_H
--- a/src/graph_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/graph_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file graph_gui.cpp */
+/** @file graph_gui.cpp GUI that shows performance graphs. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/group.h Tue May 06 15:06:19 2008 +0000
+++ b/src/group.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file group.h */
+/** @file group.h Base class from groups. */
#ifndef GROUP_H
#define GROUP_H
--- a/src/group_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/group_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file group_gui.cpp */
+/** @file group_gui.cpp GUI for the group window. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/gui.h Tue May 06 15:06:19 2008 +0000
+++ b/src/gui.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file gui.h */
+/** @file gui.h GUI functions that shouldn't be here. */
#ifndef GUI_H
#define GUI_H
--- a/src/heightmap.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/heightmap.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file heightmap.cpp */
+/** @file heightmap.cpp Creating of maps from heightmaps. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/heightmap.h Tue May 06 15:06:19 2008 +0000
+++ b/src/heightmap.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file heightmap.h */
+/** @file heightmap.h Functions related to creating heightmaps from files. */
#ifndef HEIGHTMAP_H
#define HEIGHTMAP_H
--- a/src/helpers.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/helpers.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file helpers.cpp */
+/** @file helpers.cpp Some not-so-generic helper functions. */
#include "stdafx.h"
--- a/src/industry.h Tue May 06 15:06:19 2008 +0000
+++ b/src/industry.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file industry.h */
+/** @file industry.h Base of all industries. */
#ifndef INDUSTRY_H
#define INDUSTRY_H
--- a/src/industry_cmd.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/industry_cmd.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file industry_cmd.cpp */
+/** @file industry_cmd.cpp Handling of industry tiles. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/industry_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/industry_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file industry_gui.cpp */
+/** @file industry_gui.cpp GUIs related to industries. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/intro_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/intro_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file intro_gui.cpp */
+/** @file intro_gui.cpp The main menu GUI. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/landscape.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/landscape.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file landscape.cpp Functions related to the landscape (slopes etc.). */
+
#include "stdafx.h"
#include "openttd.h"
#include "bridge_map.h"
--- a/src/landscape.h Tue May 06 15:06:19 2008 +0000
+++ b/src/landscape.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file landscape.h */
+/** @file landscape.h Functions related to OTTD's landscape. */
#ifndef LANDSCAPE_H
#define LANDSCAPE_H
--- a/src/livery.h Tue May 06 15:06:19 2008 +0000
+++ b/src/livery.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file livery.h */
+/** @file livery.h Functions/types related to livery colours. */
#ifndef LIVERY_H
#define LIVERY_H
--- a/src/main_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/main_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file main_gui.cpp */
+/** @file main_gui.cpp Handling of the main viewport. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/map.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/map.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file map.cpp */
+/** @file map.cpp Base functions related to the map and distances on them. */
#include "stdafx.h"
#include "debug.h"
--- a/src/map_func.h Tue May 06 15:06:19 2008 +0000
+++ b/src/map_func.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file map_func.h */
+/** @file map_func.h Functions related to maps. */
#ifndef MAP_FUNC_H
#define MAP_FUNC_H
--- a/src/md5.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/md5.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file md5.cpp */
+/** @file md5.cpp Creating MD5 checksums of files. */
/*
Copyright (C) 1999, 2000, 2002 Aladdin Enterprises. All rights reserved.
--- a/src/md5.h Tue May 06 15:06:19 2008 +0000
+++ b/src/md5.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file md5.h */
+/** @file md5.h Functions to create MD5 checksums. */
/*
Copyright (C) 1999, 2002 Aladdin Enterprises. All rights reserved.
--- a/src/minilzo.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/minilzo.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,39 +1,38 @@
/* $Id$ */
-/* @file minilzo.cpp -- mini subset of the LZO real-time data compression library
-
- This file is part of the LZO real-time data compression library.
-
- Copyright (C) 2002 Markus Franz Xaver Johannes Oberhumer
- Copyright (C) 2001 Markus Franz Xaver Johannes Oberhumer
- Copyright (C) 2000 Markus Franz Xaver Johannes Oberhumer
- Copyright (C) 1999 Markus Franz Xaver Johannes Oberhumer
- Copyright (C) 1998 Markus Franz Xaver Johannes Oberhumer
- Copyright (C) 1997 Markus Franz Xaver Johannes Oberhumer
- Copyright (C) 1996 Markus Franz Xaver Johannes Oberhumer
- All Rights Reserved.
-
- The LZO library is free software; you can redistribute it and/or
- modify it under the terms of the GNU General Public License as
- published by the Free Software Foundation; either version 2 of
- the License, or (at your option) any later version.
-
- The LZO library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with the LZO library; see the file COPYING.
- If not, write to the Free Software Foundation, Inc.,
- 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-
- Markus F.X.J. Oberhumer
- <markus@oberhumer.com>
- http://www.oberhumer.com/opensource/lzo/
- */
-
-/*
+/**
+ * @file minilzo.cpp -- mini subset of the LZO real-time data compression library
+ *
+ * This file is part of the LZO real-time data compression library.
+ *
+ * Copyright (C) 2002 Markus Franz Xaver Johannes Oberhumer
+ * Copyright (C) 2001 Markus Franz Xaver Johannes Oberhumer
+ * Copyright (C) 2000 Markus Franz Xaver Johannes Oberhumer
+ * Copyright (C) 1999 Markus Franz Xaver Johannes Oberhumer
+ * Copyright (C) 1998 Markus Franz Xaver Johannes Oberhumer
+ * Copyright (C) 1997 Markus Franz Xaver Johannes Oberhumer
+ * Copyright (C) 1996 Markus Franz Xaver Johannes Oberhumer
+ * All Rights Reserved.
+ *
+ * The LZO library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of
+ * the License, or (at your option) any later version.
+ *
+ * The LZO library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with the LZO library; see the file COPYING.
+ * If not, write to the Free Software Foundation, Inc.,
+ * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *
+ * Markus F.X.J. Oberhumer
+ * <markus@oberhumer.com>
+ * http://www.oberhumer.com/opensource/lzo/
+ *
* NOTE:
* the full LZO package can be found at
* http://www.oberhumer.com/opensource/lzo/
--- a/src/minilzo.h Tue May 06 15:06:19 2008 +0000
+++ b/src/minilzo.h Tue May 06 15:11:33 2008 +0000
@@ -1,45 +1,43 @@
/* $Id$ */
-/* @file minilzo.h -- mini subset of the LZO real-time data compression library
-
- This file is part of the LZO real-time data compression library.
-
- Copyright (C) 2002 Markus Franz Xaver Johannes Oberhumer
- Copyright (C) 2001 Markus Franz Xaver Johannes Oberhumer
- Copyright (C) 2000 Markus Franz Xaver Johannes Oberhumer
- Copyright (C) 1999 Markus Franz Xaver Johannes Oberhumer
- Copyright (C) 1998 Markus Franz Xaver Johannes Oberhumer
- Copyright (C) 1997 Markus Franz Xaver Johannes Oberhumer
- Copyright (C) 1996 Markus Franz Xaver Johannes Oberhumer
- All Rights Reserved.
-
- The LZO library is free software; you can redistribute it and/or
- modify it under the terms of the GNU General Public License as
- published by the Free Software Foundation; either version 2 of
- the License, or (at your option) any later version.
-
- The LZO library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with the LZO library; see the file COPYING.
- If not, write to the Free Software Foundation, Inc.,
- 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-
- Markus F.X.J. Oberhumer
- <markus@oberhumer.com>
- http://www.oberhumer.com/opensource/lzo/
- */
-
-/*
+/**
+ * @file minilzo.h Mini subset of the LZO real-time data compression library
+ *
+ * This file is part of the LZO real-time data compression library.
+ *
+ * Copyright (C) 2002 Markus Franz Xaver Johannes Oberhumer
+ * Copyright (C) 2001 Markus Franz Xaver Johannes Oberhumer
+ * Copyright (C) 2000 Markus Franz Xaver Johannes Oberhumer
+ * Copyright (C) 1999 Markus Franz Xaver Johannes Oberhumer
+ * Copyright (C) 1998 Markus Franz Xaver Johannes Oberhumer
+ * Copyright (C) 1997 Markus Franz Xaver Johannes Oberhumer
+ * Copyright (C) 1996 Markus Franz Xaver Johannes Oberhumer
+ * All Rights Reserved.
+ *
+ * The LZO library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of
+ * the License, or (at your option) any later version.
+ *
+ * The LZO library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with the LZO library; see the file COPYING.
+ * If not, write to the Free Software Foundation, Inc.,
+ * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *
+ * Markus F.X.J. Oberhumer
+ * <markus@oberhumer.com>
+ * http://www.oberhumer.com/opensource/lzo/
+ *
* NOTE:
* the full LZO package can be found at
* http://www.oberhumer.com/opensource/lzo/
*/
-
#ifndef MINILZO_H
#define MINILZO_H
--- a/src/misc.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/misc.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file misc.cpp */
+/** @file misc.cpp Misc functions that shouldn't be here. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/misc/array.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/misc/array.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file array.hpp */
+/** @file array.hpp Array without an explicit maximum size. */
#ifndef ARRAY_HPP
#define ARRAY_HPP
--- a/src/misc/binaryheap.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/misc/binaryheap.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file binaryheap.hpp */
+/** @file binaryheap.hpp Binary heap implementation. */
#ifndef BINARYHEAP_HPP
#define BINARYHEAP_HPP
--- a/src/misc/blob.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/misc/blob.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file blob.hpp */
+/** @file blob.hpp Support for storing random binary data. */
#ifndef BLOB_HPP
#define BLOB_HPP
--- a/src/misc/countedobj.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/misc/countedobj.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file countedobj.cpp Support for reference counted objects. */
+
#include "../stdafx.h"
#include "countedptr.hpp"
--- a/src/misc/crc32.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/misc/crc32.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file crc32.hpp */
+/** @file crc32.hpp Cyclic reduncancy check support. */
#ifndef CRC32_HPP
#define CRC32_HPP
--- a/src/misc/dbg_helpers.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/misc/dbg_helpers.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,7 @@
/* $Id$ */
-/** @file dbg_helpers.cpp */
+/** @file dbg_helpers.cpp Helpers for outputting debug information. */
+
#include "../stdafx.h"
#include "../openttd.h"
#include "../direction_type.h"
--- a/src/misc/dbg_helpers.h Tue May 06 15:06:19 2008 +0000
+++ b/src/misc/dbg_helpers.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file dbg_helpers.h */
+/** @file dbg_helpers.h Functions to be used for debug printings. */
#ifndef DBG_HELPERS
#define DBG_HELPERS
--- a/src/misc/fixedsizearray.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/misc/fixedsizearray.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file fixedsizearray.hpp */
+/** @file fixedsizearray.hpp A fixed size array that doesn't create items until needed. */
#ifndef FIXEDSIZEARRAY_HPP
#define FIXEDSIZEARRAY_HPP
--- a/src/misc/hashtable.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/misc/hashtable.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file hashtable.hpp */
+/** @file hashtable.hpp Hash table support. */
#ifndef HASHTABLE_HPP
#define HASHTABLE_HPP
--- a/src/misc/smallvec.h Tue May 06 15:06:19 2008 +0000
+++ b/src/misc/smallvec.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/* @file smallvec.h */
+/** @file smallvec.h Simple vector class that allows allocating an item without the need to copy data needlessly. */
#ifndef SMALLVEC_H
#define SMALLVEC_H
--- a/src/misc/str.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/misc/str.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file str.hpp */
+/** @file str.hpp String formating? */
#ifndef STR_HPP
#define STR_HPP
--- a/src/misc/strapi.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/misc/strapi.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file strapi.hpp */
+/** @file strapi.hpp More string formatting? */
#ifndef STRAPI_HPP
#define STRAPI_HPP
--- a/src/misc_cmd.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/misc_cmd.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file misc_cmd.cpp */
+/** @file misc_cmd.cpp Some misc functions that are better fitted in other files, but never got moved there... */
#include "stdafx.h"
#include "openttd.h"
--- a/src/misc_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/misc_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file misc_gui.cpp */
+/** @file misc_gui.cpp GUIs for a number of misc windows. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/mixer.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/mixer.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file mixer.cpp*/
+/** @file mixer.cpp Mixing of sound samples. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/mixer.h Tue May 06 15:06:19 2008 +0000
+++ b/src/mixer.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file mixer.h */
+/** @file mixer.h Functions to mix sound samples. */
#ifndef MIXER_H
#define MIXER_H
--- a/src/music.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/music.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file music.cpp */
+/** @file music.cpp The songs that OpenTTD knows. */
#include "stdafx.h"
#include "music.h"
--- a/src/music.h Tue May 06 15:06:19 2008 +0000
+++ b/src/music.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file music.h */
+/** @file music.h Base for the music handling. */
#ifndef MUSIC_H
#define MUSIC_H
--- a/src/music/bemidi.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/music/bemidi.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file bemidi.cpp */
+/** @file bemidi.cpp Support for BeOS midi. */
#include "../stdafx.h"
#include "../openttd.h"
--- a/src/music/bemidi.h Tue May 06 15:06:19 2008 +0000
+++ b/src/music/bemidi.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file bemidi.h Base of BeOS Midi support. */
+
#ifndef MUSIC_BEMIDI_H
#define MUSIC_BEMIDI_H
--- a/src/music/dmusic.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/music/dmusic.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file dmusic.cpp */
+/** @file dmusic.cpp Playing music via DirectMusic. */
#ifdef WIN32_ENABLE_DIRECTMUSIC_SUPPORT
--- a/src/music/dmusic.h Tue May 06 15:06:19 2008 +0000
+++ b/src/music/dmusic.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file dmusic.h Base of playing music via DirectMusic.
+
#ifndef MUSIC_DMUSIC_H
#define MUSIC_DMUSIC_H
--- a/src/music/extmidi.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/music/extmidi.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file extmidi.cpp Playing music via an external player. */
+
#ifndef __MORPHOS__
#include "../stdafx.h"
#include "../openttd.h"
--- a/src/music/extmidi.h Tue May 06 15:06:19 2008 +0000
+++ b/src/music/extmidi.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file extmidi.h Base support for playing music via an external application. */
+
#ifndef MUSIC_EXTERNAL_H
#define MUSIC_EXTERNAL_H
--- a/src/music/libtimidity.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/music/libtimidity.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file libtimidity.cpp Playing music via the timidity library. */
+
#include "../stdafx.h"
#include "../openttd.h"
#include "../sound_type.h"
--- a/src/music/libtimidity.h Tue May 06 15:06:19 2008 +0000
+++ b/src/music/libtimidity.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file libtimidity.h Base for LibTimidity music playback. */
+
#ifndef MUSIC_LIBTIMIDITY_H
#define MUSIC_LIBTIMIDITY_H
--- a/src/music/music_driver.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/music/music_driver.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file music_driver.hpp Base for all music playback. */
+
#ifndef MUSIC_MUSIC_DRIVER_HPP
#define MUSIC_MUSIC_DRIVER_HPP
--- a/src/music/null_m.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/music/null_m.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file null_m.cpp The music playback that is silent. */
+
#include "../stdafx.h"
#include "null_m.h"
--- a/src/music/null_m.h Tue May 06 15:06:19 2008 +0000
+++ b/src/music/null_m.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file null_m.h Base for the silent music playback. */
+
#ifndef MUSIC_NULL_H
#define MUSIC_NULL_H
--- a/src/music/os2_m.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/music/os2_m.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file os2_m.cpp Music playback on OS/2. */
+
#include "../stdafx.h"
#include "../openttd.h"
#include "os2_m.h"
--- a/src/music/os2_m.h Tue May 06 15:06:19 2008 +0000
+++ b/src/music/os2_m.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file os2_m.h Base for OS2 music playback. */
+
#ifndef MUSIC_OS2_H
#define MUSIC_OS2_H
--- a/src/music/qtmidi.h Tue May 06 15:06:19 2008 +0000
+++ b/src/music/qtmidi.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file qtmidi.h Base of music playback via the QuickTime driver. */
+
#ifndef MUSIC_MACOSX_QUICKTIME_H
#define MUSIC_MACOSX_QUICKTIME_H
--- a/src/music/win32_m.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/music/win32_m.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file win32_m.cpp Music playback for Windows. */
+
#include "../stdafx.h"
#include "win32_m.h"
#include <windows.h>
--- a/src/music/win32_m.h Tue May 06 15:06:19 2008 +0000
+++ b/src/music/win32_m.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file win32_m.h Base for Windows music playback. */
+
#ifndef MUSIC_WIN32_H
#define MUSIC_WIN32_H
--- a/src/music_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/music_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file music_gui.cpp */
+/** @file music_gui.cpp GUI for the music playback. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/namegen.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/namegen.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file namegen.cpp */
+/** @file namegen.cpp Town name generators. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/namegen_func.h Tue May 06 15:06:19 2008 +0000
+++ b/src/namegen_func.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file namegen.h Town name generator stuff. */
+/** @file namegen_func.h Town name generator stuff. */
#ifndef NAMEGEN_H
#define NAMEGEN_H
--- a/src/network/network.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/network/network.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file network.cpp Base functions for networking support. */
+
#include "../stdafx.h"
#include "network_data.h"
--- a/src/network/network.h Tue May 06 15:06:19 2008 +0000
+++ b/src/network/network.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file network.h Basic functions/variables used all over the place. */
+
#ifndef NETWORK_H
#define NETWORK_H
--- a/src/network/network_client.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/network/network_client.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file network_client.cpp Client part of the network protocol. */
+
#ifdef ENABLE_NETWORK
#include "../stdafx.h"
--- a/src/network/network_client.h Tue May 06 15:06:19 2008 +0000
+++ b/src/network/network_client.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file network_client.h Client part of the network protocol. */
+
#ifndef NETWORK_CLIENT_H
#define NETWORK_CLIENT_H
--- a/src/network/network_data.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/network/network_data.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file network_data.cpp Command handling over network connections. */
+
#ifdef ENABLE_NETWORK
#include "../stdafx.h"
--- a/src/network/network_data.h Tue May 06 15:06:19 2008 +0000
+++ b/src/network/network_data.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file network_data.h Internal functions. */
+
#ifndef NETWORK_DATA_H
#define NETWORK_DATA_H
--- a/src/network/network_gamelist.h Tue May 06 15:06:19 2008 +0000
+++ b/src/network/network_gamelist.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file network_gamelist.h Handling of the list of games. */
+
#ifndef NETWORK_GAMELIST_H
#define NETWORK_GAMELIST_H
--- a/src/network/network_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/network/network_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file network_gui.cpp Implementation of the Network related GUIs. */
+
#ifdef ENABLE_NETWORK
#include "../stdafx.h"
#include "../openttd.h"
--- a/src/network/network_gui.h Tue May 06 15:06:19 2008 +0000
+++ b/src/network/network_gui.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file network_gui.h GUIs related to networking. */
+
#ifndef NETWORK_GUI_H
#define NETWORK_GUI_H
--- a/src/network/network_internal.h Tue May 06 15:06:19 2008 +0000
+++ b/src/network/network_internal.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file network_internal.h Variables and function used internally. */
+
#ifndef NETWORK_INTERNAL_H
#define NETWORK_INTERNAL_H
--- a/src/network/network_server.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/network/network_server.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file network_server.cpp Server part of the network protocol. */
+
#ifdef ENABLE_NETWORK
#include "../stdafx.h"
--- a/src/network/network_server.h Tue May 06 15:06:19 2008 +0000
+++ b/src/network/network_server.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file network_server.h Server part of the network protocol. */
+
#ifndef NETWORK_SERVER_H
#define NETWORK_SERVER_H
--- a/src/network/network_udp.h Tue May 06 15:06:19 2008 +0000
+++ b/src/network/network_udp.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file network_udp.h Sending and receiving UDP messages. */
+
#ifndef NETWORK_UDP_H
#define NETWORK_UDP_H
--- a/src/newgrf.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file newgrf.cpp */
+/** @file newgrf.cpp Base of all NewGRF support. */
#include "stdafx.h"
--- a/src/newgrf.h Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file newgrf.h */
+/** @file newgrf.h Base for the NewGRF implementation. */
#ifndef NEWGRF_H
#define NEWGRF_H
--- a/src/newgrf_callbacks.h Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_callbacks.h Tue May 06 15:11:33 2008 +0000
@@ -1,12 +1,10 @@
/* $Id$ */
-/** @file newgrf_callbacks.h
- */
+/** @file newgrf_callbacks.h Callbacks that NewGRFs could implement. */
#ifndef NEWGRF_CALLBACKS_H
#define NEWGRF_CALLBACKS_H
-
/**
* List of implemented NewGRF callbacks.
* Most of these callbacks are only triggered when the corresponding
--- a/src/newgrf_canal.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_canal.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file newgrf_canal.cpp Implementation of NewGRF canals. */
+
#include "stdafx.h"
#include "openttd.h"
#include "variables.h"
--- a/src/newgrf_canal.h Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_canal.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file newgrf_canal.h Handling of NewGRF canals. */
+
#ifndef NEWGRF_CANAL_H
#define NEWGRF_CANAL_H
--- a/src/newgrf_cargo.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_cargo.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file newgrf_cargo.cpp Implementation of NewGRF cargoes. */
+
#include "stdafx.h"
#include "openttd.h"
#include "debug.h"
--- a/src/newgrf_cargo.h Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_cargo.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file newgrf_cargo.h */
+/** @file newgrf_cargo.h Cargo support for NewGRFs. */
#ifndef NEWGRF_CARGO_H
#define NEWGRF_CARGO_H
--- a/src/newgrf_config.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_config.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file newgrf_config.cpp */
+/** @file newgrf_config.cpp Finding NewGRFs and configuring them. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/newgrf_config.h Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_config.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file newgrf_config.h */
+/** @file newgrf_config.h Functions to find and configure NewGRFs. */
#ifndef NEWGRF_CONFIG_H
#define NEWGRF_CONFIG_H
--- a/src/newgrf_engine.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_engine.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file newgrf_engine.cpp */
+/** @file newgrf_engine.cpp NewGRF handling of engines. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/newgrf_engine.h Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_engine.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file newgrf_engine.h */
+/** @file newgrf_engine.h Functions for NewGRF engines. */
#ifndef NEWGRF_ENGINE_H
#define NEWGRF_ENGINE_H
--- a/src/newgrf_generic.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_generic.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file newgrf_generic.cpp Handling of generic feature callbacks. */
+
#include "stdafx.h"
#include "openttd.h"
#include "variables.h"
--- a/src/newgrf_generic.h Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_generic.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file newgrf_generic.h Functions related to generic callbacks. */
+
#ifndef NEWGRF_GENERIC_H
#define NEWGRF_GENERIC_H
--- a/src/newgrf_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file newgrf_gui.cpp */
+/** @file newgrf_gui.cpp GUI to change NewGRF settings. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/newgrf_house.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_house.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file newgrf_house.cpp */
+/** @file newgrf_house.cpp Implementation of NewGRF houses. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/newgrf_house.h Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_house.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file newgrf_house.h */
+/** @file newgrf_house.h Functions related to NewGRF houses. */
#ifndef NEWGRF_HOUSE_H
#define NEWGRF_HOUSE_H
--- a/src/newgrf_industries.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_industries.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file newgrf_industries.cpp */
+/** @file newgrf_industries.cpp Handling of NewGRF industries. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/newgrf_industries.h Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_industries.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file newgrf_industries.h */
+/** @file newgrf_industries.h Functions for NewGRF industries. */
#ifndef NEWGRF_INDUSTRIES_H
#define NEWGRF_INDUSTRIES_H
--- a/src/newgrf_industrytiles.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_industrytiles.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file newgrf_industrytiles.cpp */
+/** @file newgrf_industrytiles.cpp NewGRF handling of industry tiles. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/newgrf_industrytiles.h Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_industrytiles.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file newgrf_industrytiles.h */
+/** @file newgrf_industrytiles.h NewGRF handling of industry tiles. */
#ifndef NEWGRF_INDUSTRYTILES_H
#define NEWGRF_INDUSTRYTILES_H
--- a/src/newgrf_sound.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_sound.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file newgrf_sound.cpp */
+/** @file newgrf_sound.cpp Handling NewGRF provided sounds. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/newgrf_sound.h Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_sound.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file newgrf_sound.h */
+/** @file newgrf_sound.h Functions related to NewGRF provided sounds. */
#ifndef NEWGRF_SOUND_H
#define NEWGRF_SOUND_H
--- a/src/newgrf_spritegroup.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_spritegroup.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file newgrf_spritegroup.cpp */
+/** @file newgrf_spritegroup.cpp Handling of primarily NewGRF action 2. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/newgrf_spritegroup.h Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_spritegroup.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file newgrf_spritegroup.h */
+/** @file newgrf_spritegroup.h Action 2 handling. */
#ifndef NEWGRF_SPRITEGROUP_H
#define NEWGRF_SPRITEGROUP_H
--- a/src/newgrf_town.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_town.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file newgrf_town.cpp */
+/** @file newgrf_town.cpp Implementation of the town part of NewGRF houses. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/newgrf_town.h Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_town.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file newgrf_town.h */
+/** @file newgrf_town.h Functions to handle the town part of NewGRF towns. */
#ifndef NEWGRF_TOWN_H
#define NEWGRF_TOWN_H
--- a/src/newgrf_townname.h Tue May 06 15:06:19 2008 +0000
+++ b/src/newgrf_townname.h Tue May 06 15:11:33 2008 +0000
@@ -1,13 +1,14 @@
/* $Id$ */
+
+/** @file newgrf_townname.h
+ * Header of Action 0F "universal holder" structure and functions
+ */
+
#ifndef NEWGRF_TOWNNAME_H
#define NEWGRF_TOWNNAME_H
#include "strings_type.h"
-/** @file newgrf_townname.h
- * Header of Action 0F "universal holder" structure and functions
- */
-
struct NamePart {
byte prob; ///< The relative probablity of the following name to appear in the bottom 7 bits.
union {
--- a/src/news_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/news_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,6 @@
/* $Id$ */
+/** @file news_gui.cpp GUI functions related to news messages. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/npf.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/npf.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file npf.cpp */
+/** @file npf.cpp Implementation of the NPF pathfinder. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/npf.h Tue May 06 15:06:19 2008 +0000
+++ b/src/npf.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file npf.h */
+/** @file npf.h New A* pathfinder. */
#ifndef NPF_H
#define NPF_H
--- a/src/oldloader.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/oldloader.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file oldloader.cpp */
+/** @file oldloader.cpp Loading of old TTD(patch) savegames. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/oldpool.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/oldpool.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file oldpool.cpp */
+/** @file oldpool.cpp Implementation of the old pool. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/oldpool.h Tue May 06 15:06:19 2008 +0000
+++ b/src/oldpool.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file oldpool.h */
+/** @file oldpool.h Base for the old pool. */
#ifndef OLDPOOL_H
#define OLDPOOL_H
--- a/src/oldpool_func.h Tue May 06 15:06:19 2008 +0000
+++ b/src/oldpool_func.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,9 @@
/* $Id$ */
+/** @file oldpool_func.h Functions related to the old pool. */
+
#ifndef OLDPOOL_FUNC_H
+#define OLDPOOL_FUNC_H
#include "oldpool.h"
--- a/src/openttd.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/openttd.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file openttd.cpp */
+/** @file openttd.cpp Functions related to starting OpenTTD. */
#include "stdafx.h"
--- a/src/openttd.h Tue May 06 15:06:19 2008 +0000
+++ b/src/openttd.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file openttd.h */
+/** @file openttd.h Some generic types. */
#ifndef OPENTTD_H
#define OPENTTD_H
--- a/src/order_base.h Tue May 06 15:06:19 2008 +0000
+++ b/src/order_base.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file order_base.h */
+/** @file order_base.h Base class for orders. */
#ifndef ORDER_BASE_H
#define ORDER_BASE_H
--- a/src/order_cmd.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/order_cmd.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file order_cmd.cpp */
+/** @file order_cmd.cpp Handling of orders. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/order_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/order_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file order_gui.cpp */
+/** @file order_gui.cpp GUI related to orders. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/os/macosx/G5_detector.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/os/macosx/G5_detector.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file G5_detector.cpp Detection for G5 machines (PowerPC). */
+
#include <mach/mach.h>
#include <mach/mach_host.h>
#include <mach/host_info.h>
--- a/src/os/macosx/macos.h Tue May 06 15:06:19 2008 +0000
+++ b/src/os/macosx/macos.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file macos.h Functions related to MacOS support. */
+
#ifndef MACOS_H
#define MACOS_H
--- a/src/os/macosx/osx_stdafx.h Tue May 06 15:06:19 2008 +0000
+++ b/src/os/macosx/osx_stdafx.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file osx_stdafx.h OSX is different on some places. */
+
#ifndef MACOS_STDAFX_H
#define MACOS_STDAFX_H
--- a/src/os/macosx/splash.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/os/macosx/splash.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file splash.cpp Splash screen support for OSX. */
+
#include "../../stdafx.h"
#include "../../openttd.h"
#include "../../variables.h"
--- a/src/os/macosx/splash.h Tue May 06 15:06:19 2008 +0000
+++ b/src/os/macosx/splash.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file splash.h Functions to support splash screens for OSX. */
+
#ifndef SPLASH_H
#define SPLASH_H
--- a/src/os2.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/os2.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file os2.cpp */
+/** @file os2.cpp OS2 related OS support. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/os_timer.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/os_timer.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file os_timer.cpp */
+/** @file os_timer.cpp OS/compiler dependant real time tick sampling. */
#include "stdafx.h"
--- a/src/pathfind.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/pathfind.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file pathfind.cpp */
+/** @file pathfind.cpp Implementation of the oldest supported pathfinder. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/pathfind.h Tue May 06 15:06:19 2008 +0000
+++ b/src/pathfind.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file pathfind.h */
+/** @file pathfind.h The oldest pathfinder that's supported. */
#ifndef PATHFIND_H
#define PATHFIND_H
--- a/src/player_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/player_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file player_gui.cpp */
+/** @file player_gui.cpp Player related GUIs. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/players.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/players.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,7 +1,7 @@
/* $Id$ */
-/** @file players.cpp
- */
+/** @file players.cpp Handling of players. */
+
#include "stdafx.h"
#include "openttd.h"
#include "engine_func.h"
--- a/src/queue.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/queue.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file queue.cpp */
+/** @file queue.cpp Implementation of the Queue/Hash. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/queue.h Tue May 06 15:06:19 2008 +0000
+++ b/src/queue.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file queue.h */
+/** @file queue.h Simple Queue/Hash implementations. */
#ifndef QUEUE_H
#define QUEUE_H
--- a/src/rail.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/rail.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file rail.cpp */
+/** @file rail.cpp Implementation of rail specific functions. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/rail.h Tue May 06 15:06:19 2008 +0000
+++ b/src/rail.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file rail.h */
+/** @file rail.h Rail specific functions. */
#ifndef RAIL_H
#define RAIL_H
--- a/src/rail_cmd.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/rail_cmd.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file rail_cmd.cpp */
+/** @file rail_cmd.cpp Handling of rail tiles. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/road.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/road.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file road.cpp Generic road related functions. */
+
#include "stdafx.h"
#include "openttd.h"
#include "rail_map.h"
--- a/src/road_cmd.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/road_cmd.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file road_cmd.cpp */
+/** @file road_cmd.cpp Commands related to road tiles. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/road_cmd.h Tue May 06 15:06:19 2008 +0000
+++ b/src/road_cmd.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file road_cmd.h */
+/** @file road_cmd.h Road related functions. */
#ifndef ROAD_CMD_H
#define ROAD_CMD_H
--- a/src/road_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/road_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file road_gui.cpp */
+/** @file road_gui.cpp GUI for building roads. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/road_map.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/road_map.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file road_map.cpp */
+/** @file road_map.cpp Complex road accessors. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/road_map.h Tue May 06 15:06:19 2008 +0000
+++ b/src/road_map.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file road_map.h */
+/** @file road_map.h Map accessors for roads. */
#ifndef ROAD_MAP_H
#define ROAD_MAP_H
--- a/src/roadveh_cmd.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/roadveh_cmd.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file roadveh_cmd.cpp */
+/** @file roadveh_cmd.cpp Handling of road vehicles. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/roadveh_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/roadveh_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file roadveh_gui.cpp */
+/** @file roadveh_gui.cpp GUI for road vehicles. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/saveload.h Tue May 06 15:06:19 2008 +0000
+++ b/src/saveload.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file saveload.h */
+/** @file saveload.h Functions/types related to saving and loading games. */
#ifndef SAVELOAD_H
#define SAVELOAD_H
--- a/src/screenshot.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/screenshot.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file screenshot.cpp The creation of screenshots! */
+
#include "stdafx.h"
#include "openttd.h"
#include "debug.h"
--- a/src/screenshot.h Tue May 06 15:06:19 2008 +0000
+++ b/src/screenshot.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file screenshot.h */
+/** @file screenshot.h Functions to make screenshots. */
#ifndef SCREENSHOT_H
#define SCREENSHOT_H
--- a/src/sdl.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/sdl.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file sdl.cpp */
+/** @file sdl.cpp Implementation of SDL support. */
#include "stdafx.h"
--- a/src/sdl.h Tue May 06 15:06:19 2008 +0000
+++ b/src/sdl.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file sdl.h */
+/** @file sdl.h SDL support. */
#ifndef SDL_H
#define SDL_H
--- a/src/settings_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/settings_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file settings_gui.cpp */
+/** @file settings_gui.cpp GUI for settings. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/ship.h Tue May 06 15:06:19 2008 +0000
+++ b/src/ship.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ship.h */
+/** @file ship.h Base for ships. */
#ifndef SHIP_H
#define SHIP_H
--- a/src/ship_cmd.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/ship_cmd.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ship_cmd.cpp */
+/** @file ship_cmd.cpp Handling of ships. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/ship_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/ship_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file ship_gui.cpp */
+/** @file ship_gui.cpp GUI for ships. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/signs.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/signs.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file signs.cpp */
+/** @file signs.cpp Handling of signs. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/signs_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/signs_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file signs_gui.cpp */
+/** @file signs_gui.cpp The GUI for signs. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/smallmap_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/smallmap_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file smallmap_gui.cpp */
+/** @file smallmap_gui.cpp GUI that shows a small map of the world with metadata like owner or height. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/sound.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/sound.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file sound.cpp */
+/** @file sound.cpp Handling of playing sounds. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/sound/cocoa_s.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/sound/cocoa_s.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file cocoa_s.cpp Sound driver for cocoa. */
+
/*****************************************************************************
* Cocoa sound driver *
* Known things left to do: *
--- a/src/sound/cocoa_s.h Tue May 06 15:06:19 2008 +0000
+++ b/src/sound/cocoa_s.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file cocoa_s.h Base for Cocoa sound handling. */
+
#ifndef SOUND_COCOA_H
#define SOUND_COCOA_H
--- a/src/sound/null_s.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/sound/null_s.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file null_s.cpp The sound driver that doesn't produce sound. */
+
#include "../stdafx.h"
#include "null_s.h"
--- a/src/sound/null_s.h Tue May 06 15:06:19 2008 +0000
+++ b/src/sound/null_s.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file null_s.h Base for the sound of silence. */
+
#ifndef SOUND_NULL_H
#define SOUND_NULL_H
--- a/src/sound/sdl_s.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/sound/sdl_s.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file sdl_s.cpp Playing sound via SDL. */
+
#ifdef WITH_SDL
#include "../stdafx.h"
--- a/src/sound/sdl_s.h Tue May 06 15:06:19 2008 +0000
+++ b/src/sound/sdl_s.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file sdl_s.h Base fo playing sound via SDL. */
+
#ifndef SOUND_SDL_H
#define SOUND_SDL_H
--- a/src/sound/sound_driver.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/sound/sound_driver.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file sound_driver.hpp Base for all sound drivers. */
+
#ifndef SOUND_SOUND_DRIVER_HPP
#define SOUND_SOUND_DRIVER_HPP
--- a/src/sound/win32_s.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/sound/win32_s.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file win32_s.cpp Handling of sound for Windows. */
+
#include "../stdafx.h"
#include "../openttd.h"
#include "../driver.h"
--- a/src/sound/win32_s.h Tue May 06 15:06:19 2008 +0000
+++ b/src/sound/win32_s.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file win32_s.h Base for Windows sound handling. */
+
#ifndef SOUND_WIN32_H
#define SOUND_WIN32_H
--- a/src/sprite.h Tue May 06 15:06:19 2008 +0000
+++ b/src/sprite.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file sprite.h */
+/** @file sprite.h Base for drawing complex sprites. */
#ifndef SPRITE_H
#define SPRITE_H
--- a/src/spritecache.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/spritecache.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file spritecache.cpp */
+/** @file spritecache.cpp Caching of sprites. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/spritecache.h Tue May 06 15:06:19 2008 +0000
+++ b/src/spritecache.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file spritecache.h */
+/** @file spritecache.h Functions to cache sprites in memory. */
#ifndef SPRITECACHE_H
#define SPRITECACHE_H
--- a/src/spriteloader/grf.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/spriteloader/grf.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file grf.cpp */
+/** @file grf.cpp Reading graphics data from (New)GRF files. */
#include "../stdafx.h"
#include "../gfx_func.h"
--- a/src/spriteloader/grf.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/spriteloader/grf.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file grf.hpp */
+/** @file grf.hpp Base for reading sprites from (New)GRFs. */
#ifndef SPRITELOADER_GRF_HPP
#define SPRITELOADER_GRF_HPP
--- a/src/spriteloader/png.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/spriteloader/png.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file png.cpp */
+/** @file png.cpp Reading sprites from png files. */
#ifdef WITH_PNG
--- a/src/spriteloader/png.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/spriteloader/png.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file png.hpp */
+/** @file png.hpp Base for reading files from PNG. */
#ifndef SPRITELOADER_PNG_HPP
#define SPRITELOADER_PNG_HPP
--- a/src/spriteloader/spriteloader.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/spriteloader/spriteloader.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file spriteloader.hpp */
+/** @file spriteloader.hpp Base for loading sprites. */
#ifndef SPRITELOADER_HPP
#define SPRITELOADER_HPP
--- a/src/station.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/station.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file station.cpp */
+/** @file station.cpp Implementation of the station base class. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/station_cmd.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/station_cmd.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file station_cmd.cpp */
+/** @file station_cmd.cpp Handling of station tiles. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/station_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/station_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file station_gui.cpp */
+/** @file station_gui.cpp The GUI for stations. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/station_map.h Tue May 06 15:06:19 2008 +0000
+++ b/src/station_map.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file station_map.h */
+/** @file station_map.h Maps accessors for stations. */
#ifndef STATION_MAP_H
#define STATION_MAP_H
--- a/src/statusbar_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/statusbar_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file main_gui.cpp */
+/** @file statusbar_gui.cpp The GUI for the bottom status bar. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/stdafx.h Tue May 06 15:06:19 2008 +0000
+++ b/src/stdafx.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file stdafx.h */
+/** @file stdafx.h Definition of base types and functions in a cross-platform compatible way. */
#ifndef STDAFX_H
#define STDAFX_H
--- a/src/strgen/strgen.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/strgen/strgen.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file strgen.cpp Tool to create computer readable (stand-alone) translation files. */
+
#include "../stdafx.h"
#include "../core/alloc_func.hpp"
#include "../core/endian_func.hpp"
--- a/src/string.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/string.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file string.cpp */
+/** @file string.cpp Handling of C-type strings (char*). */
#include "stdafx.h"
#include "openttd.h"
--- a/src/strings.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/strings.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file strings.cpp */
+/** @file strings.cpp Handling of translated strings. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/subsidy_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/subsidy_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file subsidy_gui.cpp */
+/** @file subsidy_gui.cpp GUI for subsidies. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/table/ai_rail.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/ai_rail.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file ai_rail.h Tables that the default AI uses to build tracks/stations. */
+
struct AiDefaultBlockData {
byte mode;
DiagDirection attr;
--- a/src/table/autorail.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/autorail.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file autorail.h Highlight/sprite information for autorail. */
+
/* Rail selection types (directions):
* / \ / \ / \ / \ / \ / \
* / /\ /\ \ /===\ / \ /| \ / |\
--- a/src/table/build_industry.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/build_industry.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file build_industry.h */
+/** @file build_industry.h Tables with default industry layouts and behaviours. */
#ifndef BUILD_INDUSTRY_H
#define BUILD_INDUSTRY_H
--- a/src/table/cargo_const.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/cargo_const.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/* Table of all default cargo types */
+/** @file cargo_const.h Table of all default cargo types */
#define MK(bt, label, c, e, f, g, h, fr, te, ks1, ks2, ks3, ks4, ks5, l, m) \
{bt, label, 0, c, c, e, f, {g, h}, fr, te, 0, 0, ks1, ks2, ks3, ks4, ks5, l, m, NULL}
--- a/src/table/clear_land.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/clear_land.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file clear_land.h Tables with sprites for clear land and fences. */
+
static const SpriteID _landscape_clear_sprites[8] = {
0xFA0,
0xFB3,
--- a/src/table/control_codes.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/control_codes.h Tue May 06 15:11:33 2008 +0000
@@ -1,11 +1,14 @@
/* $Id$ */
+/** @file control_codes.h Control codes that are embedded in the translation strings. */
+
#ifndef CONTROL_CODES_H
#define CONTROL_CODES_H
-/* List of string control codes used for string formatting, displaying, and
- * by strgen to generate the language files. */
-
+/**
+ * List of string control codes used for string formatting, displaying, and
+ * by strgen to generate the language files.
+ */
enum StringControlCode {
SCC_CONTROL_START = 0xE000,
SCC_CONTROL_END = 0xE1FF,
--- a/src/table/elrail_data.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/elrail_data.h Tue May 06 15:11:33 2008 +0000
@@ -1,4 +1,5 @@
/* $Id$ */
+
/** @file elrail_data.h Stores all the data for overhead wire and pylon drawing.
* @see elrail.c */
--- a/src/table/engines.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/engines.h Tue May 06 15:11:33 2008 +0000
@@ -1,12 +1,12 @@
/* $Id$ */
-#ifndef ENGINES_H
-#define ENGINES_H
-
/** @file table/engines.h
* This file contains all the data for vehicles
*/
+#ifndef ENGINES_H
+#define ENGINES_H
+
enum {
RC_W = 0xFF, ///< Running cost price index (out of range) of wagons
RC_S = 0x2A, ///< Running cost price index of steam
--- a/src/table/files.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/files.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file files.h MD5 checksum information and names of the original and extra data files. */
+
/*
MD5 sums of graphics files
--- a/src/table/genland.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/genland.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file genland.h Table used to generate deserts and/or rain forests. */
+
#define M(x, y) {x, y}
static const TileIndexDiffC _make_desert_or_rainforest_data[] = {
--- a/src/table/industry_land.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/industry_land.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file industry_land.h */
+/** @file industry_land.h Information about the behaviour of the default industry tiles. */
/**
* This is used to gather some data about animation
--- a/src/table/landscape_sprite.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/landscape_sprite.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file landscape_sprite.h Offsets of sprites to replace for non-temperate landscapes. */
+
enum {
END = 0xFFFF
};
--- a/src/table/palettes.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/palettes.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file palettes.h The colour translation of the GRF palettes. */
+
#define M(r, g, b) { r, g, b }
static const Colour _palettes[][256] = {
/* palette 1 (TTD Windows) */
--- a/src/table/road_land.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/road_land.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file road_land.h Sprite constructs for road depots. */
+
#define TILE_SEQ_LINE(img, pal, dx, dy, sx, sy) { dx, dy, 0, sx, sy, 20, {img, pal} },
#define TILE_SEQ_END() { 0, 0, 0, 0, 0, 0, {0, 0} }
--- a/src/table/sprites.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/sprites.h Tue May 06 15:11:33 2008 +0000
@@ -1,8 +1,5 @@
/* $Id$ */
-#ifndef SPRITES_H
-#define SPRITES_H
-
/** @file sprites.h
* This file contails all sprite-related enums and defines. These consist mainly of
* the sprite numbers and a bunch of masks and macros to handle sprites and to get
@@ -32,6 +29,9 @@
* @todo Split the "Sprites" enum into smaller chunks and document them
*/
+#ifndef SPRITES_H
+#define SPRITES_H
+
#include "../gfx_type.h"
enum Sprites {
--- a/src/table/station_land.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/station_land.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file station_land.h Sprites to use and how to display them for station tiles. */
+
#define TILE_SEQ_LINE(dx, dy, dz, sx, sy, sz, img) { dx, dy, dz, sx, sy, sz, {img, PAL_NONE} },
#define TILE_SEQ_LINE_PAL(dx, dy, dz, sx, sy, sz, img, pal) { dx, dy, dz, sx, sy, sz, {img, pal} },
#define TILE_SEQ_END() { (byte)0x80, 0, 0, 0, 0, 0, {0, 0} }
--- a/src/table/town_land.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/town_land.h Tue May 06 15:11:33 2008 +0000
@@ -1,7 +1,6 @@
/* $Id$ */
-/** @file town_land.h */
-
+/** @file town_land.h Sprites to use and how to display them for town tiles. */
/** Writes the data into the Town Tile Drawing Struct
* @param s1 The first sprite of the building, mostly the ground sprite
--- a/src/table/track_land.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/track_land.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file track_land.h Sprites to use and how to display them for train depot/waypoint tiles. */
+
#define TILE_SEQ_LINE(img, dx, dy, sx, sy) { dx, dy, 0, sx, sy, 23, {img, PAL_NONE} },
#define TILE_SEQ_END() { (byte)0x80, 0, 0, 0, 0, 0, {0, 0} }
--- a/src/table/train_cmd.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/train_cmd.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file train_cmd.h Sprites to use for trains. */
+
static const SpriteID _engine_sprite_base[] = {
0x0B59, 0x0B61, 0x0B69, 0x0BE1, 0x0B71, 0x0B75, 0x0B7D, 0x0B7D,
0x0B85, 0x0B85, 0x0B8D, 0x0B8D, 0x0BC9, 0x0BD1, 0x0BD9, 0x0BE9,
--- a/src/table/tree_land.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/tree_land.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file tree_land.h Sprites to use and how to display them for tree tiles. */
+
#ifndef TREE_LAND_H
#define TREE_LAND_H
--- a/src/table/unicode.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/unicode.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,6 @@
/* $Id$ */
+/** @file unicode.h Character mapping for using Unicode characters in OTTD. */
struct DefaultUnicodeMapping {
WChar code; ///< Unicode value
--- a/src/table/unmovable_land.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/unmovable_land.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,6 @@
/* $Id$ */
+/** @file unmovable_land.h Sprites to use and how to display them for unmovable tiles. */
static const DrawTileSeqStruct _draw_tile_transmitterlighthouse_data[] = {
{ 7, 7, 0, 2, 2, 70, {SPR_UNMOVABLE_TRANSMITTER, PAL_NONE}},
--- a/src/table/water_land.h Tue May 06 15:06:19 2008 +0000
+++ b/src/table/water_land.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file water_land.h Sprites to use and how to display them for water tiles (depots/shiplifts). */
+
struct WaterDrawTileStruct {
byte delta_x;
byte delta_y;
--- a/src/terraform_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/terraform_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file terraform_gui.cpp */
+/** @file terraform_gui.cpp GUI related to terraforming the map. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/texteff.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/texteff.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file texteff.cpp */
+/** @file texteff.cpp Handling of text effects. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/texteff.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/texteff.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file texteff.hpp Functions related to text effects. */
+
#ifndef TEXTEFF_HPP
#define TEXTEFF_HPP
--- a/src/tgp.h Tue May 06 15:06:19 2008 +0000
+++ b/src/tgp.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file tgp.h */
+/** @file tgp.h Functions for the Perlin noise enhanced map generator. */
#ifndef TGP_H
#define TGP_H
--- a/src/thread.h Tue May 06 15:06:19 2008 +0000
+++ b/src/thread.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file thread.h */
+/** @file thread.h Base of all threads. */
#ifndef THREAD_H
#define THREAD_H
--- a/src/tile_map.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/tile_map.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file tile_map.cpp */
+/** @file tile_map.cpp Global tile accessors. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/timetable.h Tue May 06 15:06:19 2008 +0000
+++ b/src/timetable.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file timetable.h */
+/** @file timetable.h Functions related to time tabling. */
#ifndef TIMETABLE_H
#define TIMETABLE_H
--- a/src/timetable_cmd.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/timetable_cmd.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file timetable_cmd.cpp */
+/** @file timetable_cmd.cpp Commands related to time tabling. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/timetable_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/timetable_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file timetable_gui.cpp */
+/** @file timetable_gui.cpp GUI for time tabling. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/town.h Tue May 06 15:06:19 2008 +0000
+++ b/src/town.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file town.h */
+/** @file town.h Base of the town class. */
#ifndef TOWN_H
#define TOWN_H
--- a/src/town_cmd.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/town_cmd.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file town_cmd.cpp */
+/** @file town_cmd.cpp Handling of town tiles. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/town_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/town_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file town_gui.cpp */
+/** @file town_gui.cpp GUI for towns. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/train.h Tue May 06 15:06:19 2008 +0000
+++ b/src/train.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file train.h */
+/** @file train.h Base for the train class. */
#ifndef TRAIN_H
#define TRAIN_H
--- a/src/train_cmd.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/train_cmd.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file train_cmd.cpp */
+/** @file train_cmd.cpp Handling of trains. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/train_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/train_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file train_gui.cpp */
+/** @file train_gui.cpp GUI for trains. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/transparency.h Tue May 06 15:06:19 2008 +0000
+++ b/src/transparency.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file transparency.h */
+/** @file transparency.h Functions related to transparency. */
#ifndef TRANSPARENCY_H
#define TRANSPARENCY_H
--- a/src/transparency_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/transparency_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file transparency_gui.cpp The transparency GUI. */
+
#include "stdafx.h"
#include "openttd.h"
#include "gui.h"
--- a/src/transparency_gui.h Tue May 06 15:06:19 2008 +0000
+++ b/src/transparency_gui.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file transparency_gui.h GUI functions related to transparency. */
+
#ifndef TRANSPARENCY_GUI_H
#define TRANSPARENCY_GUI_H
--- a/src/tree_cmd.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/tree_cmd.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file tree_cmd.cpp */
+/** @file tree_cmd.cpp Handling of tree tiles. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/tree_map.h Tue May 06 15:06:19 2008 +0000
+++ b/src/tree_map.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file tree_map.h */
+/** @file tree_map.h Map accessors for tree tiles. */
#ifndef TREE_MAP_H
#define TREE_MAP_H
--- a/src/tunnel_map.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/tunnel_map.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file tunnel_map.cpp */
+/** @file tunnel_map.cpp Map accessors for tunnels. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/tunnel_map.h Tue May 06 15:06:19 2008 +0000
+++ b/src/tunnel_map.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file tunnel_map.h */
+/** @file tunnel_map.h Map accessors for tunnels. */
#ifndef TUNNEL_MAP_H
#define TUNNEL_MAP_H
--- a/src/unix.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/unix.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file unix.cpp */
+/** @file unix.cpp Implementation of Unix specific file handling. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/unmovable.h Tue May 06 15:06:19 2008 +0000
+++ b/src/unmovable.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file unmovable.h */
+/** @file unmovable.h Functions related to unmovable objects. */
#ifndef UNMOVABLE_H
#define UNMOVABLE_H
--- a/src/unmovable_cmd.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/unmovable_cmd.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file unmovable_cmd.cpp */
+/** @file unmovable_cmd.cpp Handling of unmovable tiles. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/unmovable_map.h Tue May 06 15:06:19 2008 +0000
+++ b/src/unmovable_map.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file unmovable_map.h */
+/** @file unmovable_map.h Map accessors for unmovable tiles. */
#ifndef UNMOVABLE_MAP_H
#define UNMOVABLE_MAP_H
--- a/src/variables.h Tue May 06 15:06:19 2008 +0000
+++ b/src/variables.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file variables.h */
+/** @file variables.h Messing file that will cease to exist some time in the future. */
#ifndef VARIABLES_H
#define VARIABLES_H
--- a/src/vehicle.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/vehicle.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file vehicle.cpp */
+/** @file vehicle.cpp Base implementations of all vehicles. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/vehicle_func.h Tue May 06 15:06:19 2008 +0000
+++ b/src/vehicle_func.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file vehicle.h Functions related to vehicles. */
+/** @file vehicle_func.h Functions related to vehicles. */
#ifndef VEHICLE_FUNC_H
#define VEHICLE_FUNC_H
--- a/src/vehicle_gui.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/vehicle_gui.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file vehicle_gui.cpp */
+/** @file vehicle_gui.cpp The base GUI for all vehicles. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/vehicle_gui.h Tue May 06 15:06:19 2008 +0000
+++ b/src/vehicle_gui.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file vehicle_gui.h */
+/** @file vehicle_gui.h Functions related to the vehicle's GUIs. */
#ifndef VEHICLE_GUI_H
#define VEHICLE_GUI_H
--- a/src/video/cocoa/cocoa_keys.h Tue May 06 15:06:19 2008 +0000
+++ b/src/video/cocoa/cocoa_keys.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file cocoa_keys.h Mappings of Cocoa keys. */
+
#ifndef COCOA_KEYS_H
#define COCOA_KEYS_H
--- a/src/video/cocoa/cocoa_v.h Tue May 06 15:06:19 2008 +0000
+++ b/src/video/cocoa/cocoa_v.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file cocoa_v.h The Cocoa video driver. */
+
#ifndef VIDEO_COCOA_H
#define VIDEO_COCOA_H
--- a/src/video/dedicated_v.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/video/dedicated_v.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file dedicated_v.cpp Dedicated server video 'driver'. */
+
#include "../stdafx.h"
#ifdef ENABLE_NETWORK
--- a/src/video/dedicated_v.h Tue May 06 15:06:19 2008 +0000
+++ b/src/video/dedicated_v.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file dedicated_v.h Base for the dedicated video driver. */
+
#ifndef VIDEO_DEDICATED_H
#define VIDEO_DEDICATED_H
--- a/src/video/null_v.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/video/null_v.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file null_v.cpp The videio driver that doesn't blit. */
+
#include "../stdafx.h"
#include "../openttd.h"
#include "../gfx_func.h"
--- a/src/video/null_v.h Tue May 06 15:06:19 2008 +0000
+++ b/src/video/null_v.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file null_v.h Base of the video driver that doesn't blit. */
+
#ifndef VIDEO_NULL_H
#define VIDEO_NULL_H
--- a/src/video/sdl_v.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/video/sdl_v.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,9 +1,10 @@
/* $Id$ */
-#include "../stdafx.h"
+/** @file sdl_v.cpp Implementation of the SDL video driver. */
#ifdef WITH_SDL
+#include "../stdafx.h"
#include "../openttd.h"
#include "../debug.h"
#include "../gfx_func.h"
--- a/src/video/sdl_v.h Tue May 06 15:06:19 2008 +0000
+++ b/src/video/sdl_v.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file sdl_v.h Base of the SDL video driver. */
+
#ifndef VIDEO_SDL_H
#define VIDEO_SDL_H
--- a/src/video/video_driver.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/video/video_driver.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file video_driver.hpp Base of all video drivers. */
+
#ifndef VIDEO_VIDEO_DRIVER_HPP
#define VIDEO_VIDEO_DRIVER_HPP
--- a/src/video/win32_v.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/video/win32_v.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file win32_v.cpp Implementation of the Windows (GDI) video driver. */
+
#include "../stdafx.h"
#include "../openttd.h"
#include "../gfx_func.h"
--- a/src/video/win32_v.h Tue May 06 15:06:19 2008 +0000
+++ b/src/video/win32_v.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file win32_v.h Base of the Windows video driver. */
+
#ifndef VIDEO_WIN32_H
#define VIDEO_WIN32_H
--- a/src/viewport.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/viewport.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file viewport.cpp
+/** @file viewport.cpp Handling of all viewports.
*
* \verbatim
* The in-game coordinate system looks like this *
--- a/src/void_map.h Tue May 06 15:06:19 2008 +0000
+++ b/src/void_map.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file void_map.h */
+/** @file void_map.h Map accessors for void tiles. */
#ifndef VOID_MAP_H
#define VOID_MAP_H
--- a/src/water_cmd.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/water_cmd.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file water_cmd.cpp */
+/** @file water_cmd.cpp Handling of water tiles. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/water_map.h Tue May 06 15:06:19 2008 +0000
+++ b/src/water_map.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file water_map.h */
+/** @file water_map.h Map accessors for water tiles. */
#ifndef WATER_MAP_H
#define WATER_MAP_H
--- a/src/waypoint.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/waypoint.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file waypoint.cpp */
+/** @file waypoint.cpp Handling of waypoints. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/waypoint.h Tue May 06 15:06:19 2008 +0000
+++ b/src/waypoint.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file waypoint.h */
+/** @file waypoint.h Base of waypoints. */
#ifndef WAYPOINT_H
#define WAYPOINT_H
--- a/src/widget.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/widget.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file widget.cpp */
+/** @file widget.cpp Handling of the default/simple widgets. */
#include "stdafx.h"
#include "openttd.h"
--- a/src/widgets/dropdown.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/widgets/dropdown.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file dropdown.cpp Implementation of the dropdown widget. */
+
#include "../stdafx.h"
#include "../openttd.h"
#include "../strings_type.h"
--- a/src/widgets/dropdown_func.h Tue May 06 15:06:19 2008 +0000
+++ b/src/widgets/dropdown_func.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file dropdown_func.h Functions related to the drop down widget. */
+
#ifndef WIDGETS_DROPDOWN_FUNC_H
#define WIDGETS_DROPDOWN_FUNC_H
--- a/src/widgets/dropdown_type.h Tue May 06 15:06:19 2008 +0000
+++ b/src/widgets/dropdown_type.h Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file dropdown_type.h Types related to the drop down widget. */
+
#ifndef WIDGETS_DROPDOWN_TYPE_H
#define WIDGETS_DROPDOWN_TYPE_H
--- a/src/window.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/window.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file window.cpp windowing system, widgets and events */
+/** @file window.cpp Windowing system, widgets and events */
#include "stdafx.h"
#include <stdarg.h>
--- a/src/yapf/nodelist.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/yapf/nodelist.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file nodelist.hpp */
+/** @file nodelist.hpp List of nodes used for the A-star pathfinder. */
#ifndef NODELIST_HPP
#define NODELIST_HPP
--- a/src/yapf/yapf.h Tue May 06 15:06:19 2008 +0000
+++ b/src/yapf/yapf.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file yapf.h */
+/** @file yapf.h Entry point for OpenTTD to YAPF. */
#ifndef YAPF_H
#define YAPF_H
--- a/src/yapf/yapf.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/yapf/yapf.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file yapf.hpp Base includes/functions for YAPF. */
+
#ifndef YAPF_HPP
#define YAPF_HPP
--- a/src/yapf/yapf_base.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/yapf/yapf_base.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file yapf_base.hpp */
+/** @file yapf_base.hpp Base classes for YAPF. */
#ifndef YAPF_BASE_HPP
#define YAPF_BASE_HPP
--- a/src/yapf/yapf_common.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/yapf/yapf_common.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file yapf_common.hpp */
+/** @file yapf_common.hpp Commonly used classes for YAPF. */
#ifndef YAPF_COMMON_HPP
#define YAPF_COMMON_HPP
--- a/src/yapf/yapf_costbase.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/yapf/yapf_costbase.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file yapf_costbase.hpp Handling of cost determination. */
+
#ifndef YAPF_COSTBASE_HPP
#define YAPF_COSTBASE_HPP
--- a/src/yapf/yapf_costcache.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/yapf/yapf_costcache.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file yapf_costcache.hpp */
+/** @file yapf_costcache.hpp Caching of segment costs. */
#ifndef YAPF_COSTCACHE_HPP
#define YAPF_COSTCACHE_HPP
--- a/src/yapf/yapf_costrail.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/yapf/yapf_costrail.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file yapf_costrail.hpp */
+/** @file yapf_costrail.hpp Cost determination for rails. */
#ifndef YAPF_COSTRAIL_HPP
#define YAPF_COSTRAIL_HPP
--- a/src/yapf/yapf_destrail.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/yapf/yapf_destrail.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file yapf_destrail.hpp */
+/** @file yapf_destrail.hpp Determining the destination for rail vehicles. */
#ifndef YAPF_DESTRAIL_HPP
#define YAPF_DESTRAIL_HPP
--- a/src/yapf/yapf_node.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/yapf/yapf_node.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file yapf_node.hpp */
+/** @file yapf_node.hpp Node in the pathfinder's graph. */
#ifndef YAPF_NODE_HPP
#define YAPF_NODE_HPP
--- a/src/yapf/yapf_node_rail.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/yapf/yapf_node_rail.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file yapf_node_rail.hpp */
+/** @file yapf_node_rail.hpp Node tailored for rail pathfinding. */
#ifndef YAPF_NODE_RAIL_HPP
#define YAPF_NODE_RAIL_HPP
--- a/src/yapf/yapf_node_road.hpp Tue May 06 15:06:19 2008 +0000
+++ b/src/yapf/yapf_node_road.hpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file yapf_node_road.hpp */
+/** @file yapf_node_road.hpp Node tailored for road pathfinding. */
#ifndef YAPF_NODE_ROAD_HPP
#define YAPF_NODE_ROAD_HPP
--- a/src/yapf/yapf_rail.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/yapf/yapf_rail.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file yapf_rail.cpp */
+/** @file yapf_rail.cpp The rail pathfinding. */
#include "../stdafx.h"
--- a/src/yapf/yapf_road.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/yapf/yapf_road.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file yapf_road.cpp */
+/** @file yapf_road.cpp The road pathfinding. */
#include "../stdafx.h"
#include "../depot_base.h"
--- a/src/yapf/yapf_settings.h Tue May 06 15:06:19 2008 +0000
+++ b/src/yapf/yapf_settings.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file yapf_settings.h */
+/** @file yapf_settings.h Penalty settings for YAPF. */
#if !defined(YAPF_SETTINGS_H) || defined(YS_DEF)
--- a/src/yapf/yapf_ship.cpp Tue May 06 15:06:19 2008 +0000
+++ b/src/yapf/yapf_ship.cpp Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file yapf_ship.cpp */
+/** @file yapf_ship.cpp Implementation of YAPF for ships. */
#include "../stdafx.h"
--- a/src/zoom_func.h Tue May 06 15:06:19 2008 +0000
+++ b/src/zoom_func.h Tue May 06 15:11:33 2008 +0000
@@ -1,6 +1,6 @@
/* $Id$ */
-/** @file zoom_func.h */
+/** @file zoom_func.h Functions related to zooming. */
#ifndef ZOOM_FUNC_H
#define ZOOM_FUNC_H