summaryrefslogtreecommitdiff
path: root/src/cargotype.cpp
diff options
context:
space:
mode:
authorfrosch <frosch@openttd.org>2010-08-01 19:22:34 +0000
committerfrosch <frosch@openttd.org>2010-08-01 19:22:34 +0000
commited4f806f1dcff2e10d2fdfb687e6bcebe9a81af3 (patch)
treedba65e1ae2fc4538779195db320eccfa441cbbd0 /src/cargotype.cpp
parent4871baf44db96137cf4b72c4f9d9595b2c29f61d (diff)
downloadopenttd-ed4f806f1dcff2e10d2fdfb687e6bcebe9a81af3.tar.xz
(svn r20283) -Codechange: Unify start of doygen comments.
Diffstat (limited to 'src/cargotype.cpp')
-rw-r--r--src/cargotype.cpp15
1 files changed, 10 insertions, 5 deletions
diff --git a/src/cargotype.cpp b/src/cargotype.cpp
index ecad2308e..94edd27f5 100644
--- a/src/cargotype.cpp
+++ b/src/cargotype.cpp
@@ -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