From ed4f806f1dcff2e10d2fdfb687e6bcebe9a81af3 Mon Sep 17 00:00:00 2001 From: frosch Date: Sun, 1 Aug 2010 19:22:34 +0000 Subject: (svn r20283) -Codechange: Unify start of doygen comments. --- src/cargotype.cpp | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) (limited to 'src/cargotype.cpp') 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 -- cgit v1.2.3-54-g00ecf