(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

@@ -19,7 +19,8 @@
/**
* All default airport tiles.
* @see AirportTiles for a list of names. */
* @see AirportTiles for a list of names.
*/
static const AirportTileSpec _origin_airporttile_specs[] = {
/* 0..9 */
AT_NOANIM,

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

View File

@@ -45,7 +45,8 @@ struct DrawIndustryCoordinates {
* @param h height of the sprite
* @param dz virtual height of the sprite
* @param p this allows to specify a special drawing procedure.
* @see DrawBuildingsTileStruct */
* @see DrawBuildingsTileStruct
*/
#define M(s1, p1, s2, p2, sx, sy, w, h, dz, p) { { s1, p1 }, { s2, p2 }, sx, sy, w, h, dz, p }
/** Structure for industry tiles drawing */

View File

@@ -1455,7 +1455,8 @@ enum Modifiers {
/**
* Masks needed for sprite operations.
* @note Do not modify this enum. Alter SpriteSetup instead
* @see SpriteSetup */
* @see SpriteSetup
*/
enum SpriteMasks {
/** Maximum number of sprites that can be loaded at a given time. */
MAX_SPRITES = 1 << SPRITE_WIDTH,

View File

@@ -21,7 +21,8 @@
* @param h the height of the sprite
* @param dz the virtual height of the sprite
* @param p set to 1 if a lift is present ()
* @see DrawBuildingsTileStruct */
* @see DrawBuildingsTileStruct
*/
#define M(s1, p1, s2, p2, sx, sy, w, h, dz, p) { { s1, p1 }, { s2, p2 }, sx, sy, w, h, dz, p}
/** structure of houses graphics*/
@@ -1828,7 +1829,8 @@ static const HouseSpec _original_house_specs[] = {
* +-building_flags | | | | | | | |
* +-building_availability | | | | | | |
* +-cargoID accepted | | | | | | | |
* | | | | | | | | | | | */
* | | | | | | | | | | |
*/
MS(1963, MAX_YEAR, 187, 150, STR_TOWN_BUILDING_NAME_TALL_OFFICE_BLOCK_1, 140, 70, 8, 3, 4,
TILE_SIZE_1x1,
HZ_TEMP | HZ_ZON5,