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

(svn r18413) -Doc: Added doxygen strings for cargo-type related enums, structs, and functions.

Browse Source
This commit is contained in:
alberth
2009-12-05 21:39:28 +00:00
parent 29606c0de6
commit 41d2214e7e
4 changed files with 62 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/cargotype.cpp
View File

@@ -20,10 +20,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.
* @param l Landscape
*/
void SetupCargoForClimate(LandscapeID l)
{
assert(l < lengthof(_default_climate_cargo));
@@ -60,7 +64,10 @@ void SetupCargoForClimate(LandscapeID l)
}
}
/** Get the cargo ID by cargo label.
* @param cl Cargo type to get.
* @return ID number if the cargo exists, else #CT_INVALID
*/
CargoID GetCargoIDByLabel(CargoLabel cl)
{
const CargoSpec *cs;
@@ -75,7 +82,7 @@ CargoID GetCargoIDByLabel(CargoLabel cl)
/** 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.
* @return First CargoID with the given bitnum, or #CT_INVALID if not found or if the provided \a bitnum is invalid.
*/
CargoID GetCargoIDByBitnum(uint8 bitnum)
{