(svn r9320) [NoAI] -Fix: added some doxygen comments to make doxygen happy noai
authortruelight
Mon, 19 Mar 2007 12:30:11 +0000
branchnoai
changeset 9475 58c20c0e394f
parent 9474 2b53e154a8d5
child 9476 1d1ed96f32ad
(svn r9320) [NoAI] -Fix: added some doxygen comments to make doxygen happy
src/ai/api/ai_execmode.hpp
src/ai/api/ai_object.hpp
src/ai/api/ai_testmode.hpp
src/ai/api/ai_transactionmode.hpp
--- a/src/ai/api/ai_execmode.hpp	Mon Mar 19 12:25:17 2007 +0000
+++ b/src/ai/api/ai_execmode.hpp	Mon Mar 19 12:30:11 2007 +0000
@@ -20,6 +20,9 @@
 	AIObject *last_instance;
 
 protected:
+	/**
+	 * The callback proc for Execute mode.
+	 */
 	static bool ModeProc(TileIndex tile, uint32 p1, uint32 p2, uint32 flags, uint procc, int32 costs);
 
 public:
--- a/src/ai/api/ai_object.hpp	Mon Mar 19 12:25:17 2007 +0000
+++ b/src/ai/api/ai_object.hpp	Mon Mar 19 12:30:11 2007 +0000
@@ -8,6 +8,9 @@
 #include "../../stdafx.h"
 #include "../../functions.h"
 
+/**
+ * The callback function for Mode-classes.
+ */
 typedef bool (AIModeProc)(TileIndex tile, uint32 p1, uint32 p2, uint32 flags, uint procc, int32 costs);
 
 /**
--- a/src/ai/api/ai_testmode.hpp	Mon Mar 19 12:25:17 2007 +0000
+++ b/src/ai/api/ai_testmode.hpp	Mon Mar 19 12:30:11 2007 +0000
@@ -22,6 +22,9 @@
 	AIObject *last_instance;
 
 protected:
+	/**
+	 * The callback proc for Testing mode.
+	 */
 	static bool ModeProc(TileIndex tile, uint32 p1, uint32 p2, uint32 flags, uint procc, int32 costs);
 
 public:
--- a/src/ai/api/ai_transactionmode.hpp	Mon Mar 19 12:25:17 2007 +0000
+++ b/src/ai/api/ai_transactionmode.hpp	Mon Mar 19 12:30:11 2007 +0000
@@ -39,6 +39,9 @@
 	int32 costs;
 
 protected:
+	/**
+	 * The callback proc for Transaction mode.
+	 */
 	static bool ModeProc(TileIndex tile, uint32 p1, uint32 p2, uint32 flags, uint procc, int32 costs);
 
 public: