(svn r12606) [NoAI] -Fix: minor documentation inconsistancy, to make doxygen even more happy noai
authortruebrain
Mon, 07 Apr 2008 12:43:46 +0000
branchnoai
changeset 9873 b1ab23560ecb
parent 9872 d4321b8dd97b
child 9874 4ecef0dadf01
(svn r12606) [NoAI] -Fix: minor documentation inconsistancy, to make doxygen even more happy
src/ai/api/ai_bridge.hpp
src/ai/api/ai_error.hpp
src/ai/api/ai_object.hpp
src/ai/api/ai_station.hpp
--- a/src/ai/api/ai_bridge.hpp	Mon Apr 07 12:35:43 2008 +0000
+++ b/src/ai/api/ai_bridge.hpp	Mon Apr 07 12:43:46 2008 +0000
@@ -18,6 +18,9 @@
  */
 class AIBridge : public AIObject {
 public:
+	/**
+	 * All bridge related error messages.
+	 */
 	enum ErrorMessages {
 		/** Base for bridge related errors */
 		ERR_BRIDGE_BASE = AIError::ERR_CAT_BRIDGE << AIError::ERR_CAT_BIT_SIZE,
--- a/src/ai/api/ai_error.hpp	Mon Apr 07 12:35:43 2008 +0000
+++ b/src/ai/api/ai_error.hpp	Mon Apr 07 12:43:46 2008 +0000
@@ -44,7 +44,7 @@
 	};
 
 	/**
-	 * General error messages (0x0100 - 0x0200).
+	 * All general related error messages.
 	 */
 	enum ErrorMessages {
 		/** Initial error value */
--- a/src/ai/api/ai_object.hpp	Mon Apr 07 12:35:43 2008 +0000
+++ b/src/ai/api/ai_object.hpp	Mon Apr 07 12:43:46 2008 +0000
@@ -81,7 +81,6 @@
 
 	/**
 	 * Set the DoCommand last error.
-	 * @note last_error is an ERR_* from a ErrorMessages enum.
 	 */
 	static void SetLastError(AIErrorType last_error);
 
--- a/src/ai/api/ai_station.hpp	Mon Apr 07 12:35:43 2008 +0000
+++ b/src/ai/api/ai_station.hpp	Mon Apr 07 12:43:46 2008 +0000
@@ -17,7 +17,7 @@
 	static const char *GetClassName() { return "AIStation"; }
 
 	/**
-	 * All station related errors.
+	 * All station related error messages.
 	 */
 	enum ErrorMessages {
 		/** Base for station related errors */