petern/OpenTTD
1
0
Fork 0
forked from mirror/OpenTTD
Code Pull Requests Activity

(svn r20283) -Codechange: Unify start of doygen comments.

Browse Source
This commit is contained in:
frosch
2010-08-01 19:22:34 +00:00
parent 4871baf44d
commit ed4f806f1d
162 changed files with 1304 additions and 652 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/cargotype.cpp
View File

@@ -22,12 +22,14 @@
CargoSpec CargoSpec::array[NUM_CARGO];
/** Bitmask of cargo types available.
/**
* Bitmask of cargo types available.
* Initialized during a call to #SetupCargoForClimate.
*/
uint32 _cargo_mask;
/** Set up the default cargo types for the given landscape type.
/**
* Set up the default cargo types for the given landscape type.
* @param l Landscape
*/
void SetupCargoForClimate(LandscapeID l)
@@ -66,7 +68,8 @@ void SetupCargoForClimate(LandscapeID l)
}
}
/** Get the cargo ID by cargo label.
/**
* Get the cargo ID by cargo label.
* @param cl Cargo type to get.
* @return ID number if the cargo exists, else #CT_INVALID
*/
@@ -82,7 +85,8 @@ CargoID GetCargoIDByLabel(CargoLabel cl)
}
/** Find the CargoID of a 'bitnum' value.
/**
* Find the CargoID of a 'bitnum' value.
* @param bitnum 'bitnum' to find.
* @return First CargoID with the given bitnum, or #CT_INVALID if not found or if the provided \a bitnum is invalid.
*/
@@ -99,7 +103,8 @@ CargoID GetCargoIDByBitnum(uint8 bitnum)
return CT_INVALID;
}
/** Get sprite for showing cargo of this type.
/**
* Get sprite for showing cargo of this type.
* @return Sprite number to use.
*/
SpriteID CargoSpec::GetCargoIcon() const