src/ai/api/ai_cargo.hpp
branchnoai
changeset 9835 2541c2d325ed
parent 9829 80fbe02a4184
child 10196 aecabd927420
--- a/src/ai/api/ai_cargo.hpp	Mon Mar 31 06:48:59 2008 +0000
+++ b/src/ai/api/ai_cargo.hpp	Mon Mar 31 07:21:39 2008 +0000
@@ -16,33 +16,34 @@
 
 	/**
 	 * Checks whether the given cargo type is valid.
-	 * @param cargo_type the cargo to check.
-	 * @return true if and only if the cargo type is valid.
+	 * @param cargo_type The cargo to check.
+	 * @return True if and only if the cargo type is valid.
 	 */
 	static bool IsValidCargo(CargoID cargo_type);
 
 	/**
 	 * Gets the string representation of the cargo label.
-	 * @param cargo_type to get the string representation of.
-	 * @return the cargo label.
-	 * @note the returned cargo label must be free'd (C++ only).
+	 * @param cargo_type The cargo to get the string representation of.
+	 * @return The cargo label.
+	 * @note Never use this to check if it is a certain cargo. NewGRF can
+	 *  redefine all of the names.
 	 */
 	static char *GetCargoLabel(CargoID cargo_type);
 
 	/**
 	 * Checks whether the give cargo is a freight or not.
-	 * @param cargo_type is this cargo freight or not?
-	 * @return true if and only if the cargo is freight.
+	 * @param cargo_type The cargo to check on.
+	 * @return True if and only if the cargo is freight.
 	 */
 	static bool IsFreight(CargoID cargo_type);
 
 	/**
 	 * Get the income for transporting a piece of cargo over the
 	 *   given distance within the specified time.
-	 * @param cargo_type the cargo to transport.
-	 * @param distance the distance the cargo travels from begin to end.
-	 * @param days_in_transit amount of (game) days the cargo is in transit.
-	 * @return the amount of money that would be earned by this trip.
+	 * @param cargo_type The cargo to transport.
+	 * @param distance The distance the cargo travels from begin to end.
+	 * @param days_in_transit Amount of (game) days the cargo is in transit.
+	 * @return The amount of money that would be earned by this trip.
 	 */
 	static int32 GetCargoIncome(CargoID cargo_type, uint32 distance, uint32 days_in_transit);
 };