Mercurial > hg > openttd

changeset 18365:7306b5e98497 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
(svn r23201) -Doc: [NoAI] Hide all contents of AIObject from the API documentation as AIs were never able to use it anyway
author yexo <yexo@openttd.org>
date Sat, 12 Nov 2011 18:48:21 +0000
parents 44e727d12094
children c39d9366fc24
files src/ai/ai_gui.cpp src/ai/api/Doxyfile src/ai/api/ai_bridge.hpp src/ai/api/ai_event_types.hpp src/ai/api/ai_info_docs.hpp src/ai/api/ai_list.hpp src/ai/api/ai_object.hpp src/ai/api/ai_order.hpp src/ai/api/ai_tunnel.hpp
diffstat 9 files changed, 13 insertions(+), 18 deletions(-) [+]
line wrap: on
line diff
--- a/src/ai/ai_gui.cpp
+++ b/src/ai/ai_gui.cpp
@@ -294,7 +294,7 @@
 
 		this->SetWidgetDisabledState(AIS_WIDGET_RESET, _game_mode != GM_MENU && Company::IsValidID(this->slot));
 
-		this->vscroll->SetCount(this->visible_settings.size());
+		this->vscroll->SetCount((int)this->visible_settings.size());
 	}
 
 	/**
--- a/src/ai/api/Doxyfile
+++ b/src/ai/api/Doxyfile
@@ -206,7 +206,7 @@
 SEARCH_INCLUDES        = YES
 INCLUDE_PATH           =
 INCLUDE_FILE_PATTERNS  =
-PREDEFINED             = DOXYGEN_SKIP
+PREDEFINED             = DOXYGEN_AI_DOCS
 EXPAND_AS_DEFINED      = DEF_COMMAND
 SKIP_FUNCTION_MACROS   = YES
 #---------------------------------------------------------------------------
--- a/src/ai/api/ai_bridge.hpp
+++ b/src/ai/api/ai_bridge.hpp
@@ -109,7 +109,7 @@
 	 */
 	static int32 GetMinLength(BridgeID bridge_id);
 
-#ifndef DOXYGEN_SKIP
+#ifndef DOXYGEN_AI_DOCS
 	/**
 	 * Internal function to help BuildBridge in case of road.
 	 */
--- a/src/ai/api/ai_event_types.hpp
+++ b/src/ai/api/ai_event_types.hpp
@@ -282,7 +282,7 @@
 	 * Get the type of the offered engine.
 	 * @return The type the engine has.
 	 */
-#ifdef DOXYGEN_SKIP
+#ifdef DOXYGEN_AI_DOCS
 	AIVehicle::VehicleType GetVehicleType();
 #else
 	int32 GetVehicleType();
--- a/src/ai/api/ai_info_docs.hpp
+++ b/src/ai/api/ai_info_docs.hpp
@@ -10,7 +10,7 @@
 /** @file ai_info_docs.hpp Description of the functions an AI can/must provide in AIInfo. */
 
 /* This file exists purely for doxygen purposes. */
-#ifdef DOXYGEN_SKIP
+#ifdef DOXYGEN_AI_DOCS
 /**
  * 'Abstract' class of the class AIs/AI libraries use to register themselves.
  *
--- a/src/ai/api/ai_list.hpp
+++ b/src/ai/api/ai_list.hpp
@@ -239,7 +239,7 @@
 	 */
 	void KeepList(AIList *list);
 
-#ifndef DOXYGEN_SKIP
+#ifndef DOXYGEN_AI_DOCS
 	/**
 	 * Used for 'foreach()' and [] get from Squirrel.
 	 */
@@ -280,7 +280,7 @@
 	 *  list.Valuate(MyVal, 12);
 	 */
 	void Valuate(void *valuator_function, int params, ...);
-#endif /* DOXYGEN_SKIP */
+#endif /* DOXYGEN_AI_DOCS */
 };
 
 #endif /* AI_LIST_HPP */
--- a/src/ai/api/ai_object.hpp
+++ b/src/ai/api/ai_object.hpp
@@ -38,6 +38,7 @@
 friend void CcAI(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2);
 friend class AIInstance;
 friend class AIController;
+#ifndef DOXYGEN_AI_DOCS
 protected:
 	/**
 	 * Executes a raw DoCommand for the AI.
@@ -181,51 +182,45 @@
 public:
 	/**
 	 * Store the latest result of a DoCommand per company.
-	 * @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 company.
-	 * @note NEVER use this yourself in your AI!
 	 * @param vehicle_id The new VehicleID.
 	 */
 	static void SetNewVehicleID(VehicleID vehicle_id);
 
 	/**
 	 * Store a new_sign_id per company.
-	 * @note NEVER use this yourself in your AI!
 	 * @param sign_id The new SignID.
 	 */
 	static void SetNewSignID(SignID sign_id);
 
 	/**
 	 * Store a new_tunnel_endtile per company.
-	 * @note NEVER use this yourself in your AI!
 	 * @param tile The new TileIndex.
 	 */
 	static void SetNewTunnelEndtile(TileIndex tile);
 
 	/**
 	 * Store a new_group_id per company.
-	 * @note NEVER use this yourself in your AI!
 	 * @param group_id The new GroupID.
 	 */
 	static void SetNewGroupID(GroupID group_id);
 
 	/**
 	 * Store a allow_do_command per company.
-	 * @note NEVER use this yourself in your AI!
 	 * @param allow The new allow.
 	 */
 	static void SetAllowDoCommand(bool allow);
 
 	/**
 	 * Get the pointer to store log message in.
-	 * @note NEVER use this yourself in your AI!
 	 */
 	static void *&GetLogPointer();
+#endif /* DOXYGEN_AI_DOCS */
 };
 
 #endif /* AI_OBJECT_HPP */
--- a/src/ai/api/ai_order.hpp
+++ b/src/ai/api/ai_order.hpp
@@ -480,12 +480,12 @@
 	 */
 	static bool RemoveOrder(VehicleID vehicle_id, OrderPosition order_position);
 
-#ifndef DOXYGEN_SKIP
+#ifndef DOXYGEN_AI_DOCS
 	/**
 	 * Internal function to help SetOrderFlags.
 	 */
 	static bool _SetOrderFlags();
-#endif /* DOXYGEN_SKIP */
+#endif /* DOXYGEN_AI_DOCS */
 
 	/**
 	 * Changes the order flags of the given order.
--- a/src/ai/api/ai_tunnel.hpp
+++ b/src/ai/api/ai_tunnel.hpp
@@ -65,7 +65,7 @@
 	 */
 	static TileIndex GetOtherTunnelEnd(TileIndex tile);
 
-#ifndef DOXYGEN_SKIP
+#ifndef DOXYGEN_AI_DOCS
 	/**
 	 * Internal function to help BuildTunnel in case of road.
 	 */
@@ -75,7 +75,7 @@
 	 * Internal function to help BuildTunnel in case of road.
 	 */
 	static bool _BuildTunnelRoad2();
-#endif /* DOXYGEN_SKIP */
+#endif /* DOXYGEN_AI_DOCS */
 
 	/**
 	 * Builds a tunnel starting at start. The direction of the tunnel depends