summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authortruebrain <truebrain@openttd.org>2011-11-29 23:27:34 +0000
committertruebrain <truebrain@openttd.org>2011-11-29 23:27:34 +0000
commit549e072041b06d72f7c832f94e609222045ccd13 (patch)
treede1d37df2f321be2d3612242f8648209f904c82e /src
parent4d91f645c15bb3128adf969afcf7f15bd0f14fa0 (diff)
downloadopenttd-549e072041b06d72f7c832f94e609222045ccd13.tar.xz
(svn r23371) -Change: rename the DOXYGEN_AI_DOCS tag to DOXYGEN_API
Diffstat (limited to 'src')
-rw-r--r--src/ai/api/Doxyfile2
-rw-r--r--src/ai/api/ai_info_docs.hpp3
-rw-r--r--src/ai/api/squirrel_export.awk6
-rw-r--r--src/script/api/script_bridge.hpp4
-rw-r--r--src/script/api/script_event_types.hpp4
-rw-r--r--src/script/api/script_list.hpp4
-rw-r--r--src/script/api/script_order.hpp3
-rw-r--r--src/script/api/script_tunnel.hpp4
8 files changed, 14 insertions, 16 deletions
diff --git a/src/ai/api/Doxyfile b/src/ai/api/Doxyfile
index f830dbd18..9ce9684a3 100644
--- a/src/ai/api/Doxyfile
+++ b/src/ai/api/Doxyfile
@@ -206,7 +206,7 @@ EXPAND_ONLY_PREDEF = YES
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
-PREDEFINED = DOXYGEN_AI_DOCS
+PREDEFINED = DOXYGEN_API
EXPAND_AS_DEFINED = DEF_COMMAND
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
diff --git a/src/ai/api/ai_info_docs.hpp b/src/ai/api/ai_info_docs.hpp
index 74edcfbb4..1f8f8b1fb 100644
--- 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 @@ public:
*/
void AddLabels(const char *setting_name, table value_names);
};
-#endif
diff --git a/src/ai/api/squirrel_export.awk b/src/ai/api/squirrel_export.awk
index dcfd4f893..56d5ee1b3 100644
--- a/src/ai/api/squirrel_export.awk
+++ b/src/ai/api/squirrel_export.awk
@@ -159,9 +159,9 @@ BEGIN {
/^( *)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";
diff --git a/src/script/api/script_bridge.hpp b/src/script/api/script_bridge.hpp
index f18bebc41..29bca9e40 100644
--- a/src/script/api/script_bridge.hpp
+++ b/src/script/api/script_bridge.hpp
@@ -107,17 +107,17 @@ public:
*/
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.
diff --git a/src/script/api/script_event_types.hpp b/src/script/api/script_event_types.hpp
index c3e4a87c0..f849c2d19 100644
--- a/src/script/api/script_event_types.hpp
+++ b/src/script/api/script_event_types.hpp
@@ -270,11 +270,11 @@ public:
* 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.
diff --git a/src/script/api/script_list.hpp b/src/script/api/script_list.hpp
index c38315763..42655e950 100644
--- a/src/script/api/script_list.hpp
+++ b/src/script/api/script_list.hpp
@@ -237,7 +237,7 @@ public:
*/
void KeepList(ScriptList *list);
-#ifndef DOXYGEN_AI_DOCS
+#ifndef DOXYGEN_API
/**
* Used for 'foreach()' and [] get from Squirrel.
*/
@@ -278,7 +278,7 @@ public:
* list.Valuate(MyVal, 12);
*/
void Valuate(void *valuator_function, int params, ...);
-#endif /* DOXYGEN_AI_DOCS */
+#endif /* DOXYGEN_API */
};
#endif /* SCRIPT_LIST_HPP */
diff --git a/src/script/api/script_order.hpp b/src/script/api/script_order.hpp
index 5cf08f74b..bc9d25493 100644
--- a/src/script/api/script_order.hpp
+++ b/src/script/api/script_order.hpp
@@ -478,12 +478,11 @@ public:
*/
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.
diff --git a/src/script/api/script_tunnel.hpp b/src/script/api/script_tunnel.hpp
index 5ca9ee8b3..80f69d69c 100644
--- a/src/script/api/script_tunnel.hpp
+++ b/src/script/api/script_tunnel.hpp
@@ -63,17 +63,17 @@ public:
*/
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