changeset 18527:0f414a707909 draft

(svn r23371) -Change: rename the DOXYGEN_AI_DOCS tag to DOXYGEN_API
author truebrain <truebrain@openttd.org>
date Tue, 29 Nov 2011 23:27:34 +0000
parents 6f84531b2f16
children b2fe136b1528
files src/ai/api/Doxyfile src/ai/api/ai_info_docs.hpp src/ai/api/squirrel_export.awk src/script/api/script_bridge.hpp src/script/api/script_event_types.hpp src/script/api/script_list.hpp src/script/api/script_order.hpp src/script/api/script_tunnel.hpp
diffstat 8 files changed, 14 insertions(+), 16 deletions(-) [+]
line wrap: on
line diff
--- a/src/ai/api/Doxyfile
+++ b/src/ai/api/Doxyfile
@@ -206,7 +206,7 @@
 SEARCH_INCLUDES        = YES
 INCLUDE_PATH           =
 INCLUDE_FILE_PATTERNS  =
-PREDEFINED             = DOXYGEN_AI_DOCS
+PREDEFINED             = DOXYGEN_API
 EXPAND_AS_DEFINED      = DEF_COMMAND
 SKIP_FUNCTION_MACROS   = YES
 #---------------------------------------------------------------------------
--- 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_AI_DOCS
+
 /**
  * 'Abstract' class of the class AIs/AI libraries use to register themselves.
  *
@@ -241,4 +241,3 @@
 	 */
 	void AddLabels(const char *setting_name, table value_names);
 };
-#endif
--- a/src/ai/api/squirrel_export.awk
+++ b/src/ai/api/squirrel_export.awk
@@ -159,9 +159,9 @@
 /^(	*)private/   { if (cls_level == 1) public = "false"; next; }
 
 # Ignore special doxygen blocks
-/^#ifndef DOXYGEN_AI_DOCS/          { doxygen_skip = "next"; next; }
-/^#ifdef DOXYGEN_AI_DOCS/           { doxygen_skip = "true"; next; }
-/^#endif \/\* DOXYGEN_AI_DOCS \*\// { doxygen_skip = "false"; next; }
+/^#ifndef DOXYGEN_API/          { doxygen_skip = "next"; next; }
+/^#ifdef DOXYGEN_API/           { doxygen_skip = "true"; next; }
+/^#endif \/\* DOXYGEN_API \*\// { doxygen_skip = "false"; next; }
 /^#else/                         {
 	if (doxygen_skip == "next") {
 		doxygen_skip = "true";
--- a/src/script/api/script_bridge.hpp
+++ b/src/script/api/script_bridge.hpp
@@ -107,17 +107,17 @@
 	 */
 	static int32 GetMinLength(BridgeID bridge_id);
 
-#ifndef DOXYGEN_AI_DOCS
 	/**
 	 * Internal function to help BuildBridge in case of road.
+	 * @api -all
 	 */
 	static bool _BuildBridgeRoad1();
 
 	/**
 	 * Internal function to help BuildBridge in case of road.
+	 * @api -all
 	 */
 	static bool _BuildBridgeRoad2();
-#endif
 
 	/**
 	 * Build a bridge from one tile to the other.
--- a/src/script/api/script_event_types.hpp
+++ b/src/script/api/script_event_types.hpp
@@ -270,11 +270,11 @@
 	 * Get the type of the offered engine.
 	 * @return The type the engine has.
 	 */
-#ifdef DOXYGEN_AI_DOCS
+#ifdef DOXYGEN_API
 	ScriptVehicle::VehicleType GetVehicleType();
 #else
 	int32 GetVehicleType();
-#endif
+#endif /* DOXYGEN_API */
 
 	/**
 	 * Accept the engine preview.
--- a/src/script/api/script_list.hpp
+++ b/src/script/api/script_list.hpp
@@ -237,7 +237,7 @@
 	 */
 	void KeepList(ScriptList *list);
 
-#ifndef DOXYGEN_AI_DOCS
+#ifndef DOXYGEN_API
 	/**
 	 * Used for 'foreach()' and [] get from Squirrel.
 	 */
@@ -278,7 +278,7 @@
 	 *  list.Valuate(MyVal, 12);
 	 */
 	void Valuate(void *valuator_function, int params, ...);
-#endif /* DOXYGEN_AI_DOCS */
+#endif /* DOXYGEN_API */
 };
 
 #endif /* SCRIPT_LIST_HPP */
--- a/src/script/api/script_order.hpp
+++ b/src/script/api/script_order.hpp
@@ -478,12 +478,11 @@
 	 */
 	static bool RemoveOrder(VehicleID vehicle_id, OrderPosition order_position);
 
-#ifndef DOXYGEN_AI_DOCS
 	/**
 	 * Internal function to help SetOrderFlags.
+	 * @api -all
 	 */
 	static bool _SetOrderFlags();
-#endif /* DOXYGEN_AI_DOCS */
 
 	/**
 	 * Changes the order flags of the given order.
--- a/src/script/api/script_tunnel.hpp
+++ b/src/script/api/script_tunnel.hpp
@@ -63,17 +63,17 @@
 	 */
 	static TileIndex GetOtherTunnelEnd(TileIndex tile);
 
-#ifndef DOXYGEN_AI_DOCS
 	/**
 	 * Internal function to help BuildTunnel in case of road.
+	 * @api -all
 	 */
 	static bool _BuildTunnelRoad1();
 
 	/**
 	 * Internal function to help BuildTunnel in case of road.
+	 * @api -all
 	 */
 	static bool _BuildTunnelRoad2();
-#endif /* DOXYGEN_AI_DOCS */
 
 	/**
 	 * Builds a tunnel starting at start. The direction of the tunnel depends