From d03994098be29bd48f3b715c533ffac3b1315eb0 Mon Sep 17 00:00:00 2001
From: rubidium <rubidium@openttd.org>
Date: Tue, 6 May 2008 15:11:33 +0000
Subject: (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.

---
 src/table/ai_rail.h          | 2 ++
 src/table/autorail.h         | 2 ++
 src/table/build_industry.h   | 2 +-
 src/table/cargo_const.h      | 2 +-
 src/table/clear_land.h       | 2 ++
 src/table/control_codes.h    | 9 ++++++---
 src/table/elrail_data.h      | 1 +
 src/table/engines.h          | 6 +++---
 src/table/files.h            | 2 ++
 src/table/genland.h          | 2 ++
 src/table/industry_land.h    | 2 +-
 src/table/landscape_sprite.h | 2 ++
 src/table/palettes.h         | 2 ++
 src/table/road_land.h        | 2 ++
 src/table/sprites.h          | 6 +++---
 src/table/station_land.h     | 2 ++
 src/table/town_land.h        | 3 +--
 src/table/track_land.h       | 2 ++
 src/table/train_cmd.h        | 2 ++
 src/table/tree_land.h        | 2 ++
 src/table/unicode.h          | 1 +
 src/table/unmovable_land.h   | 1 +
 src/table/water_land.h       | 2 ++
 23 files changed, 45 insertions(+), 14 deletions(-)

(limited to 'src/table')

diff --git a/src/table/ai_rail.h b/src/table/ai_rail.h
index c95ccfb6f..5649637c1 100644
--- a/src/table/ai_rail.h
+++ b/src/table/ai_rail.h
@@ -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;
diff --git a/src/table/autorail.h b/src/table/autorail.h
index f80b500c8..9e858c10b 100644
--- a/src/table/autorail.h
+++ b/src/table/autorail.h
@@ -1,5 +1,7 @@
 /* $Id$ */
 
+/** @file autorail.h Highlight/sprite information for autorail. */
+
 /* Rail selection types (directions):
  *  / \    / \    / \    / \   / \   / \
  * /  /\  /\  \  /===\  /   \ /|  \ /  |\
diff --git a/src/table/build_industry.h b/src/table/build_industry.h
index 64b01899f..ff2e000ae 100644
--- a/src/table/build_industry.h
+++ b/src/table/build_industry.h
@@ -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
diff --git a/src/table/cargo_const.h b/src/table/cargo_const.h
index 6c24716f5..8467cb730 100644
--- a/src/table/cargo_const.h
+++ b/src/table/cargo_const.h
@@ -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}
diff --git a/src/table/clear_land.h b/src/table/clear_land.h
index 581c86855..cd2658798 100644
--- a/src/table/clear_land.h
+++ b/src/table/clear_land.h
@@ -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,
diff --git a/src/table/control_codes.h b/src/table/control_codes.h
index 1af7befd7..d889ba193 100644
--- a/src/table/control_codes.h
+++ b/src/table/control_codes.h
@@ -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,
diff --git a/src/table/elrail_data.h b/src/table/elrail_data.h
index f929f6a9a..f9682aca5 100644
--- a/src/table/elrail_data.h
+++ b/src/table/elrail_data.h
@@ -1,4 +1,5 @@
 /* $Id$ */
+
 /** @file elrail_data.h Stores all the data for overhead wire and pylon drawing.
  *  @see elrail.c */
 
diff --git a/src/table/engines.h b/src/table/engines.h
index 8d892972a..d8db147dd 100644
--- a/src/table/engines.h
+++ b/src/table/engines.h
@@ -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
diff --git a/src/table/files.h b/src/table/files.h
index eeaab5c44..8381672ca 100644
--- a/src/table/files.h
+++ b/src/table/files.h
@@ -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
 
diff --git a/src/table/genland.h b/src/table/genland.h
index 4007f8db3..179cc0346 100644
--- a/src/table/genland.h
+++ b/src/table/genland.h
@@ -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[] = {
diff --git a/src/table/industry_land.h b/src/table/industry_land.h
index 1f41101fa..d688cf3e2 100644
--- a/src/table/industry_land.h
+++ b/src/table/industry_land.h
@@ -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
diff --git a/src/table/landscape_sprite.h b/src/table/landscape_sprite.h
index 1665720a3..e5f3d8ed2 100644
--- a/src/table/landscape_sprite.h
+++ b/src/table/landscape_sprite.h
@@ -1,5 +1,7 @@
 /* $Id$ */
 
+/** @file landscape_sprite.h Offsets of sprites to replace for non-temperate landscapes. */
+
 enum {
 	END  = 0xFFFF
 };
diff --git a/src/table/palettes.h b/src/table/palettes.h
index d1bff7cb6..51e5dc571 100644
--- a/src/table/palettes.h
+++ b/src/table/palettes.h
@@ -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) */
diff --git a/src/table/road_land.h b/src/table/road_land.h
index 4ce0c20fb..5a221a6cb 100644
--- a/src/table/road_land.h
+++ b/src/table/road_land.h
@@ -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} }
 
diff --git a/src/table/sprites.h b/src/table/sprites.h
index cc2cb6af7..115ed663d 100644
--- a/src/table/sprites.h
+++ b/src/table/sprites.h
@@ -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 {
diff --git a/src/table/station_land.h b/src/table/station_land.h
index f02990f8d..249b6f482 100644
--- a/src/table/station_land.h
+++ b/src/table/station_land.h
@@ -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} }
diff --git a/src/table/town_land.h b/src/table/town_land.h
index 89d7d30a1..3c1980dd8 100644
--- a/src/table/town_land.h
+++ b/src/table/town_land.h
@@ -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
diff --git a/src/table/track_land.h b/src/table/track_land.h
index 3f4a00fb9..b27c09d1a 100644
--- a/src/table/track_land.h
+++ b/src/table/track_land.h
@@ -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} }
 
diff --git a/src/table/train_cmd.h b/src/table/train_cmd.h
index 1bf8e70c8..63f9a292a 100644
--- a/src/table/train_cmd.h
+++ b/src/table/train_cmd.h
@@ -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,
diff --git a/src/table/tree_land.h b/src/table/tree_land.h
index e775c9384..3e6ea5060 100644
--- a/src/table/tree_land.h
+++ b/src/table/tree_land.h
@@ -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
 
diff --git a/src/table/unicode.h b/src/table/unicode.h
index d6ed30f7b..cec329b9c 100644
--- a/src/table/unicode.h
+++ b/src/table/unicode.h
@@ -1,5 +1,6 @@
 /* $Id$ */
 
+/** @file unicode.h Character mapping for using Unicode characters in OTTD. */
 
 struct DefaultUnicodeMapping {
 	WChar code; ///< Unicode value
diff --git a/src/table/unmovable_land.h b/src/table/unmovable_land.h
index e7a97cb89..063a89f84 100644
--- a/src/table/unmovable_land.h
+++ b/src/table/unmovable_land.h
@@ -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}},
diff --git a/src/table/water_land.h b/src/table/water_land.h
index c6de3c9c8..3a5c01f27 100644
--- a/src/table/water_land.h
+++ b/src/table/water_land.h
@@ -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;
-- 
cgit v1.2.3-54-g00ecf