(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.

replace/41b28d7194a279bdc17475d4fbe2ea6ec885a466
rubidium 16 years ago
parent fb938a2cb3
commit d03994098b

@ -76,7 +76,7 @@ WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = ./
INPUT = ./src/
FILE_PATTERNS = *.c \
*.cc \
*.cxx \

@ -1,5 +1,7 @@
/* $Id$ */
/** @file ai.cpp Base for all AIs. */
#include "../stdafx.h"
#include "../openttd.h"
#include "../variables.h"

@ -1,5 +1,7 @@
/* $Id$ */
/** @file ai.h Base functions for all AIs. */
#ifndef AI_H
#define AI_H

@ -1,5 +1,7 @@
/* $Id$ */
/** @file default.cpp The original AI. */
#include "../../stdafx.h"
#include "../../openttd.h"
#include "../../aircraft.h"

@ -1,5 +1,7 @@
/* $Id$ */
/** @file default.h The original AI. */
#ifndef DEFAULT_H
#define DEFAULT_H

@ -1,5 +1,7 @@
/* $Id$ */
/** @file build.cpp Building support for the trolly AI. */
#include "../../stdafx.h"
#include "../../openttd.h"
#include "../../debug.h"

@ -1,5 +1,7 @@
/* $Id$ */
/** @file pathfinder.cpp Pathfinder support for the trolly AI. */
#include "../../stdafx.h"
#include "../../openttd.h"
#include "../../bridge_map.h"

@ -1,5 +1,7 @@
/* $Id$ */
/** @file shared.cpp Shared functions for the trolly AI. */
#include "../../stdafx.h"
#include "../../openttd.h"
#include "../../debug.h"

@ -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.

@ -1,5 +1,7 @@
/* $Id$ */
/** @file trolly.h Functions/defines related to the trolly AI. */
#ifndef AI_TROLLY_H
#define AI_TROLLY_H

@ -1,6 +1,6 @@
/* $Id$ */
/** @file aircraft.h */
/** @file aircraft.h Base for aircraft. */
#ifndef AIRCRAFT_H
#define AIRCRAFT_H

@ -1,6 +1,6 @@
/* $Id$ */
/** @file aircraft_gui.cpp */
/** @file aircraft_gui.cpp The GUI of aircraft. */
#include "stdafx.h"
#include "openttd.h"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file airport.cpp */
/** @file airport.cpp Functions related to airports. */
#include "stdafx.h"
#include "openttd.h"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file airport_gui.cpp */
/** @file airport_gui.cpp The GUI for airports. */
#include "stdafx.h"
#include "openttd.h"

@ -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

@ -1,6 +1,6 @@
/* $Id$ */
/** @file articulated_vehicles.cpp */
/** @file articulated_vehicles.cpp Implementation of articulated vehicles. */
#include "stdafx.h"
#include "openttd.h"

@ -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

@ -1,6 +1,6 @@
/* $Id$ */
/** @file autoreplace_gui.cpp */
/** @file autoreplace_gui.cpp GUI for autoreplace handling. */
#include "stdafx.h"
#include "openttd.h"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file autoslope.h */
/** @file autoslope.h Functions related to autoslope. */
#ifndef AUTOSLOPE_H
#define AUTOSLOPE_H

@ -1,6 +1,6 @@
/* $Id$ */
/** @file aystar.cpp */
/** @file aystar.cpp Implementation of A*. */
/*
* This file has the core function for AyStar

@ -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"

@ -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

@ -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"

@ -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

@ -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"

@ -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

@ -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"

@ -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

@ -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"

@ -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

@ -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"

@ -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

@ -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"

@ -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

@ -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"

@ -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

@ -1,5 +1,7 @@
/* $Id$ */
/** @file base.hpp Base for all blitters. */
#ifndef BLITTER_BASE_HPP
#define BLITTER_BASE_HPP

@ -1,5 +1,7 @@
/* $Id$ */
/** @file factory.hpp Factory to 'query' all available blitters. */
#ifndef BLITTER_FACTORY_HPP
#define BLITTER_FACTORY_HPP

@ -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

@ -1,6 +1,6 @@
/* $Id$ */
/** @file bmp.cpp */
/** @file bmp.cpp Read and write support for bmps. */
#include "stdafx.h"
#include "bmp.h"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file bmp.h */
/** @file bmp.h Read and write support for bmps. */
#ifndef BMP_H
#define BMP_H

@ -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"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file callback_table.cpp */
/** @file callback_table.cpp All command callbacks. */
#include "stdafx.h"
#include "openttd.h"

@ -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

@ -1,6 +1,6 @@
/* $Id$ */
/** @file cargopacket.h */
/** @file cargopacket.h Base class for cargo packets. */
#ifndef CARGOPACKET_H
#define CARGOPACKET_H

@ -1,6 +1,6 @@
/* $Id$ */
/** @file cargotype.cpp */
/** @file cargotype.cpp Implementation of cargos. */
#include "stdafx.h"
#include "openttd.h"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file cargotype.h */
/** @file cargotype.h Types/functions related to cargos. */
#ifndef CARGOTYPE_H
#define CARGOTYPE_H

@ -1,6 +1,6 @@
/* $Id$ */
/** @file misc.cpp */
/** @file cheat.cpp Handling (loading/saving/initializing) of cheats. */
#include "stdafx.h"
#include "saveload.h"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file misc_gui.cpp */
/** @file cheat_gui.cpp GUI related to cheating. */
#include "stdafx.h"
#include "openttd.h"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file clear_cmd.cpp */
/** @file clear_cmd.cpp Commands related to clear tiles. */
#include "stdafx.h"
#include "openttd.h"

@ -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

@ -1,6 +1,6 @@
/* $Id$ */
/** @file command.cpp */
/** @file command.cpp Handling of commands. */
#include "stdafx.h"
#include "openttd.h"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file console.cpp */
/** @file console.cpp Handling of the in-game console. */
#include "stdafx.h"
#include "openttd.h"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file console.h */
/** @file console.h In-game console. */
#ifndef CONSOLE_H
#define CONSOLE_H

@ -1,6 +1,6 @@
/* $Id$ */
/** @file console_cmds.cpp */
/** @file console_cmds.cpp Implementation of the console hooks. */
#include "stdafx.h"
#include "openttd.h"

@ -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"

@ -1,4 +1,3 @@
/* $Id$ */
/** @file alloc_type.hpp Helper types related to the allocation of memory */

@ -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"

@ -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

@ -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

@ -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"

@ -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

@ -1,6 +1,6 @@
/* $Id$ */
/** @file currency.cpp **/
/** @file currency.cpp Support for different currencies. */
#include "stdafx.h"
#include "openttd.h"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file currency.h */
/** @file currency.h Functions to handle different currencies. */
#ifndef CURRENCY_H
#define CURRENCY_H

@ -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"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file debug.cpp */
/** @file debug.cpp Handling of printing debug messages. */
#include "stdafx.h"
#include <stdio.h>

@ -1,6 +1,6 @@
/* $Id$ */
/** @file debug.h */
/** @file debug.h Functions related to debugging. */
#ifndef DEBUG_H
#define DEBUG_H

@ -1,6 +1,6 @@
/* $Id$ */
/** @file dedicated.cpp */
/** @file dedicated.cpp Forking support for dedicated servers. */
#include "stdafx.h"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file depot.cpp */
/** @file depot.cpp Handling of depots. */
#include "stdafx.h"
#include "openttd.h"

@ -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

@ -1,6 +1,6 @@
/* $Id$ */
/** @file depot_gui.cpp */
/** @file depot_gui.cpp The GUI for depots. */
#include "stdafx.h"
#include "openttd.h"

@ -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"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file driver.cpp */
/** @file driver.cpp Base for all driver handling. */
#include "stdafx.h"
#include "openttd.h"

@ -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

@ -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"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file economy.cpp */
/** @file economy.cpp Handling of the economy. */
#include "stdafx.h"
#include "openttd.h"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file vehicle.cpp */
/** @file effectvehicle.cpp Implementation of everything generic to vehicles. */
#include "stdafx.h"
#include "openttd.h"

@ -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

@ -1,4 +1,5 @@
/* $Id$ */
/** @file elrail.cpp
* This file deals with displaying wires and pylons for electric railways.
* <h2>Basics</h2>

@ -1,6 +1,6 @@
/* $Id$ */
/** @file engine.cpp */
/** @file engine.cpp Base for all engine handling. */
#include "stdafx.h"
#include "openttd.h"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file engine_func.h */
/** @file engine_func.h Functions related to engines. */
#ifndef ENGINE_H
#define ENGINE_H

@ -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"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file fiber.hpp */
/** @file fiber.hpp Base for all fiber related classes. */
#ifndef FIBER_HPP
#define FIBER_HPP

@ -1,6 +1,6 @@
/* $Id$ */
/** @file fontcache.cpp */
/** @file fontcache.cpp Cache for characters from fonts. */
#include "stdafx.h"
#include "openttd.h"

@ -1,5 +1,7 @@
/* $Id$ */
/** @file fontcache.h Functions to read fonts from files and cache them. */
#ifndef FONTCACHE_H
#define FONTCACHE_H

@ -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

@ -1,6 +1,6 @@
/* $Id$ */
/** @file genworld.cpp */
/** @file genworld.cpp Functions to generate a map. */
#include "stdafx.h"
#include "openttd.h"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file genworld.h */
/** @file genworld.h Functions related to world/map generation. */
#ifndef GENWORLD_H
#define GENWORLD_H

@ -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"

@ -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"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file gfxinit.cpp */
/** @file gfxinit.cpp Initializing of the (GRF) graphics. */
#include "stdafx.h"
#include "openttd.h"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file gfxinit.h */
/** @file gfxinit.h Functions related to the graphics initialization. */
#ifndef GFXINIT_H
#define GFXINIT_H

@ -1,6 +1,6 @@
/* $Id$ */
/** @file graph_gui.cpp */
/** @file graph_gui.cpp GUI that shows performance graphs. */
#include "stdafx.h"
#include "openttd.h"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file group.h */
/** @file group.h Base class from groups. */
#ifndef GROUP_H
#define GROUP_H

@ -1,6 +1,6 @@
/* $Id$ */
/** @file group_gui.cpp */
/** @file group_gui.cpp GUI for the group window. */
#include "stdafx.h"
#include "openttd.h"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file gui.h */
/** @file gui.h GUI functions that shouldn't be here. */
#ifndef GUI_H
#define GUI_H

@ -1,6 +1,6 @@
/* $Id$ */
/** @file heightmap.cpp */
/** @file heightmap.cpp Creating of maps from heightmaps. */
#include "stdafx.h"
#include "openttd.h"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file heightmap.h */
/** @file heightmap.h Functions related to creating heightmaps from files. */
#ifndef HEIGHTMAP_H
#define HEIGHTMAP_H

@ -1,6 +1,6 @@
/* $Id$ */
/** @file helpers.cpp */
/** @file helpers.cpp Some not-so-generic helper functions. */
#include "stdafx.h"

@ -1,6 +1,6 @@
/* $Id$ */
/** @file industry.h */
/** @file industry.h Base of all industries. */
#ifndef INDUSTRY_H
#define INDUSTRY_H

Some files were not shown because too many files have changed in this diff Show More

Loading…
Cancel
Save