(svn r12412) [NoAI] -Fix: three functions missed documentation noai
authortruebrain
Tue, 25 Mar 2008 12:16:30 +0000
branchnoai
changeset 9815 efac4d882b25
parent 9814 be51ea0adc29
child 9816 35e866676c00
(svn r12412) [NoAI] -Fix: three functions missed documentation
src/ai/api/ai_base.hpp
src/ai/api/ai_bridgelist.hpp
--- a/src/ai/api/ai_base.hpp	Tue Mar 25 12:12:45 2008 +0000
+++ b/src/ai/api/ai_base.hpp	Tue Mar 25 12:16:30 2008 +0000
@@ -56,6 +56,8 @@
 	/**
 	 * Returns approximatelly 'out' times true when called 'max' times.
 	 *   After all, it is a random function.
+	 * @param out how many times it should return true.
+	 * @param max out of this many times.
 	 * @return true if the chance worked out.
 	 */
 	static bool Chance(uint out, uint max);
@@ -64,6 +66,8 @@
 	 * Returns approximatelly 'out' times true when called 'max' times.
 	 *   After all, it is a random function.
 	 * @param unused_param This param is not used, but is needed to work with lists.
+	 * @param out how many times it should return true.
+	 * @param max out of this many times.
 	 * @return true if the chance worked out.
 	 */
 	static bool ChanceItem(int unused_param, uint out, uint max);
--- a/src/ai/api/ai_bridgelist.hpp	Tue Mar 25 12:12:45 2008 +0000
+++ b/src/ai/api/ai_bridgelist.hpp	Tue Mar 25 12:16:30 2008 +0000
@@ -28,6 +28,10 @@
 class AIBridgeList_Length : public AIAbstractList {
 public:
 	static const char *GetClassName() { return "AIBridgeList_Length"; }
+
+	/**
+	 * @param length The length of the bridge you want to build.
+	 */
 	AIBridgeList_Length(uint length);
 
 private: