(svn r20286) -Codechange: Unify end of doxygen comments.

This commit is contained in:
frosch
2010-08-01 19:44:49 +00:00
parent 971691b691
commit c18839704b
93 changed files with 424 additions and 220 deletions

View File

@@ -9,14 +9,16 @@
/**
* @file elrail_data.h Stores all the data for overhead wire and pylon drawing.
* @see elrail.c */
* @see elrail.c
*/
#ifndef ELRAIL_DATA_H
#define ELRAIL_DATA_H
/**
* Tile Location group.
* This defines whether the X and or Y coordinate of a tile is even */
* This defines whether the X and or Y coordinate of a tile is even
*/
enum TLG {
XEVEN_YEVEN = 0,
XEVEN_YODD = 1,
@@ -28,7 +30,8 @@ enum TLG {
/**
* When determining the pylon configuration on the edge, two tiles are taken
* into account: the tile being drawn itself (the home tile, the one in
* ti->tile), and the neighbouring tile */
* ti->tile), and the neighbouring tile
*/
enum TileSource {
TS_HOME = 0,
TS_NEIGHBOUR = 1,
@@ -49,7 +52,8 @@ static const byte AllowedPPPonPCP[DIAGDIR_END] = {
/**
* Which of the PPPs are inside the tile. For the two PPPs on the tile border
* the following system is used: if you rotate the PCP so that it is in the
* north, the eastern PPP belongs to the tile. */
* north, the eastern PPP belongs to the tile.
*/
static const byte OwnedPPPonPCP[DIAGDIR_END] = {
1 << DIR_SE | 1 << DIR_S | 1 << DIR_SW | 1 << DIR_W,
1 << DIR_N | 1 << DIR_SW | 1 << DIR_W | 1 << DIR_NW,
@@ -72,7 +76,8 @@ static const DiagDirection PCPpositions[TRACK_END][2] = {
* Preferred points of each trackbit. Those are the ones perpendicular to the
* track, plus the point in extension of the track (to mark end-of-track). PCPs
* which are not on either end of the track are fully preferred.
* @see PCPpositions */
* @see PCPpositions
*/
static const byte PreferredPPPofTrackAtPCP[TRACK_END][DIAGDIR_END] = {
{ // X
1 << DIR_NE | 1 << DIR_SE | 1 << DIR_NW, // NE
@@ -114,7 +119,8 @@ static const byte PreferredPPPofTrackAtPCP[TRACK_END][DIAGDIR_END] = {
/**
* In case we have a staight line, we place pylon only every two tiles,
* so there are certain tiles which we ignore. A straight line is found if
* we have exactly two PPPs. */
* we have exactly two PPPs.
*/
static const byte IgnoredPCP[NUM_IGNORE_GROUPS][TLG_END][DIAGDIR_END] = {
{ // Ignore group 1, X and Y tracks
{ // X even, Y even