--- a/src/ai/api/ai_sign.hpp Mon Mar 31 07:50:27 2008 +0000
+++ b/src/ai/api/ai_sign.hpp Mon Mar 31 08:42:20 2008 +0000
@@ -16,51 +16,48 @@
/**
* Gets the maximum sign index; there are no valid signs with a higher index.
- * @return the maximum sign index.
- * @post return value is always non-negative.
+ * @return The maximum sign index.
+ * @post Return value is always non-negative.
*/
static SignID GetMaxSignID();
/**
* Gets the number of signs. This is different than GetMaxSignID()
* because of the way OpenTTD works internally.
- * @return the number of signs.
- * @post return value is always non-negative.
+ * @return The number of signs.
+ * @post Return value is always non-negative.
*/
static int32 GetSignCount();
/**
* Checks whether the given sign index is valid.
- * @param sign_id the index to check.
- * @return true if and only if the sign is valid.
+ * @param sign_id The index to check.
+ * @return True if and only if the sign is valid.
*/
static bool IsValidSign(SignID sign_id);
/**
* Get the text on the sign.
- * @param sign_id the sign to get the text of.
- * @pre sign_id has to be valid (use IsValidSign()).
- * @return the text on the sign.
- * @note the returned name must be free'd (C++ only).
+ * @param sign_id The sign to get the text of.
+ * @pre IsValidSign(sign_id).
+ * @return The text on the sign.
*/
static char *GetText(SignID sign_id);
/**
* Gets the location of the sign.
- * @param sign_id the sign to get the location of.
- * @pre sign_id has to be valid (use IsValidSign()).
- * @return the location of the sign.
- * @post return value is always valid with AIMap::IsValidTile().
+ * @param sign_id The sign to get the location of.
+ * @pre IsValidSign(sign_id).
+ * @return The location of the sign.
*/
static TileIndex GetLocation(SignID sign_id);
/**
* Builds a sign on the map.
- * @param location the place to build the sign.
- * @param text the text to place on the sign.
+ * @param location The place to build the sign.
+ * @param text The text to place on the sign.
* @pre AIMap::IsValidTile(location).
- * @pre text is not NULL and non-empty, i.e. length is positive.
- * @return the SignID of the build sign (use IsValidSign() to check for validity).
+ * @return The SignID of the build sign (use IsValidSign() to check for validity).
* In test-mode it returns 0 if successful, or any other value to indicate
* failure.
*/
@@ -68,9 +65,9 @@
/**
* Removes a sign from the map.
- * @param sign_id the sign to remove.
- * @pre sign_id has to be valid (use IsValidSign()).
- * @return true if and only if the sign has been removed.
+ * @param sign_id The sign to remove.
+ * @pre IsValidSign(sign_id).
+ * @return True if and only if the sign has been removed.
*/
static bool RemoveSign(SignID sign_id);
};