(svn r12507) [NoAI] -Fix: enable Doxyfile warning about missing params and fix 3 missing params in AIObject
--- a/src/ai/api/Doxyfile Mon Mar 31 09:20:12 2008 +0000
+++ b/src/ai/api/Doxyfile Mon Mar 31 09:25:03 2008 +0000
@@ -81,7 +81,7 @@
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
-WARN_NO_PARAMDOC = NO
+WARN_NO_PARAMDOC = YES
WARN_FORMAT = "$file:$line: $text "
WARN_LOGFILE =
#---------------------------------------------------------------------------
--- a/src/ai/api/ai_object.cpp Mon Mar 31 09:20:12 2008 +0000
+++ b/src/ai/api/ai_object.cpp Mon Mar 31 09:25:03 2008 +0000
@@ -63,9 +63,9 @@
return AIObject::GetDoCommandStruct(_current_player)->last_command_res;
}
-void AIObject::SetNewVehicleID(VehicleID vehicle)
+void AIObject::SetNewVehicleID(VehicleID vehicle_id)
{
- AIObject::GetDoCommandStruct(_current_player)->new_vehicle_id = vehicle;
+ AIObject::GetDoCommandStruct(_current_player)->new_vehicle_id = vehicle_id;
}
VehicleID AIObject::GetNewVehicleID()
@@ -73,9 +73,9 @@
return AIObject::GetDoCommandStruct(_current_player)->new_vehicle_id;
}
-void AIObject::SetNewSignID(SignID sign)
+void AIObject::SetNewSignID(SignID sign_id)
{
- AIObject::GetDoCommandStruct(_current_player)->new_sign_id = sign;
+ AIObject::GetDoCommandStruct(_current_player)->new_sign_id = sign_id;
}
SignID AIObject::GetNewSignID()
--- a/src/ai/api/ai_object.hpp Mon Mar 31 09:20:12 2008 +0000
+++ b/src/ai/api/ai_object.hpp Mon Mar 31 09:25:03 2008 +0000
@@ -120,20 +120,23 @@
/**
* Store the latest result of a DoCommand per player.
* @note NEVER use this yourself in your AI!
+ * @param res The result of the last command.
*/
static void SetLastCommandRes(bool res);
/**
* Store a new_vehicle_id per player.
* @note NEVER use this yourself in your AI!
+ * @param vehicle_id The new VehicleID.
*/
- static void SetNewVehicleID(VehicleID vehicle);
+ static void SetNewVehicleID(VehicleID vehicle_id);
/**
* Store a new_sign_id per player.
* @note NEVER use this yourself in your AI!
+ * @param sign_id The new SignID.
*/
- static void SetNewSignID(SignID vehicle);
+ static void SetNewSignID(SignID sign_id);
/**
* If an AI starts, some internals needs to be resetted. This function