mirror
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD
1
0
Fork 0
Code Issues

(svn r23371) -Change: rename the DOXYGEN_AI_DOCS tag to DOXYGEN_API

release/1.2
truebrain 2011-11-29 23:27:34 +00:00
parent 4d91f645c1
commit 549e072041
8 changed files with 14 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/ai/api/Doxyfile
View File

@ -206,7 +206,7 @@ EXPAND_ONLY_PREDEF = YES
SEARCH_INCLUDES = YES SEARCH_INCLUDES = YES
INCLUDE_PATH = INCLUDE_PATH =
INCLUDE_FILE_PATTERNS = INCLUDE_FILE_PATTERNS =
PREDEFINED = DOXYGEN_AI_DOCS PREDEFINED = DOXYGEN_API
EXPAND_AS_DEFINED = DEF_COMMAND EXPAND_AS_DEFINED = DEF_COMMAND
SKIP_FUNCTION_MACROS = YES SKIP_FUNCTION_MACROS = YES
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------

3
src/ai/api/ai_info_docs.hpp
View File

@ -10,7 +10,7 @@
/** @file ai_info_docs.hpp Description of the functions an AI can/must provide in AIInfo. */ /** @file ai_info_docs.hpp Description of the functions an AI can/must provide in AIInfo. */
/* This file exists purely for doxygen purposes. */ /* This file exists purely for doxygen purposes. */
#ifdef DOXYGEN_AI_DOCS
/** /**
* 'Abstract' class of the class AIs/AI libraries use to register themselves. * '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); void AddLabels(const char *setting_name, table value_names);
}; };
#endif

6
src/ai/api/squirrel_export.awk
View File

@ -159,9 +159,9 @@ BEGIN {
/^( *)private/ { if (cls_level == 1) public = "false"; next; } /^( *)private/ { if (cls_level == 1) public = "false"; next; }
# Ignore special doxygen blocks # Ignore special doxygen blocks
/^#ifndef DOXYGEN_AI_DOCS/ { doxygen_skip = "next"; next; } /^#ifndef DOXYGEN_API/ { doxygen_skip = "next"; next; }
/^#ifdef DOXYGEN_AI_DOCS/ { doxygen_skip = "true"; next; } /^#ifdef DOXYGEN_API/ { doxygen_skip = "true"; next; }
/^#endif \/\* DOXYGEN_AI_DOCS \*\// { doxygen_skip = "false"; next; } /^#endif \/\* DOXYGEN_API \*\// { doxygen_skip = "false"; next; }
/^#else/ { /^#else/ {
if (doxygen_skip == "next") { if (doxygen_skip == "next") {
doxygen_skip = "true"; doxygen_skip = "true";

4
src/script/api/script_bridge.hpp
View File

@ -107,17 +107,17 @@ public:
*/ */
static int32 GetMinLength(BridgeID bridge_id); static int32 GetMinLength(BridgeID bridge_id);
#ifndef DOXYGEN_AI_DOCS
/** /**
* Internal function to help BuildBridge in case of road. * Internal function to help BuildBridge in case of road.
* @api -all
*/ */
static bool _BuildBridgeRoad1(); static bool _BuildBridgeRoad1();
/** /**
* Internal function to help BuildBridge in case of road. * Internal function to help BuildBridge in case of road.
* @api -all
*/ */
static bool _BuildBridgeRoad2(); static bool _BuildBridgeRoad2();
#endif
/** /**
* Build a bridge from one tile to the other. * Build a bridge from one tile to the other.

4
src/script/api/script_event_types.hpp
View File

@ -270,11 +270,11 @@ public:
* Get the type of the offered engine. * Get the type of the offered engine.
* @return The type the engine has. * @return The type the engine has.
*/ */
#ifdef DOXYGEN_AI_DOCS #ifdef DOXYGEN_API
ScriptVehicle::VehicleType GetVehicleType(); ScriptVehicle::VehicleType GetVehicleType();
#else #else
int32 GetVehicleType(); int32 GetVehicleType();
#endif #endif /* DOXYGEN_API */
/** /**
* Accept the engine preview. * Accept the engine preview.

4
src/script/api/script_list.hpp
View File

@ -237,7 +237,7 @@ public:
*/ */
void KeepList(ScriptList *list); void KeepList(ScriptList *list);
#ifndef DOXYGEN_AI_DOCS #ifndef DOXYGEN_API
/** /**
* Used for 'foreach()' and [] get from Squirrel. * Used for 'foreach()' and [] get from Squirrel.
*/ */
@ -278,7 +278,7 @@ public:
* list.Valuate(MyVal, 12); * list.Valuate(MyVal, 12);
*/ */
void Valuate(void *valuator_function, int params, ...); void Valuate(void *valuator_function, int params, ...);
#endif /* DOXYGEN_AI_DOCS */ #endif /* DOXYGEN_API */
}; };
#endif /* SCRIPT_LIST_HPP */ #endif /* SCRIPT_LIST_HPP */

3
src/script/api/script_order.hpp
View File

@ -478,12 +478,11 @@ public:
*/ */
static bool RemoveOrder(VehicleID vehicle_id, OrderPosition order_position); static bool RemoveOrder(VehicleID vehicle_id, OrderPosition order_position);
#ifndef DOXYGEN_AI_DOCS
/** /**
* Internal function to help SetOrderFlags. * Internal function to help SetOrderFlags.
* @api -all
*/ */
static bool _SetOrderFlags(); static bool _SetOrderFlags();
#endif /* DOXYGEN_AI_DOCS */
/** /**
* Changes the order flags of the given order. * Changes the order flags of the given order.

4
src/script/api/script_tunnel.hpp
View File

@ -63,17 +63,17 @@ public:
*/ */
static TileIndex GetOtherTunnelEnd(TileIndex tile); static TileIndex GetOtherTunnelEnd(TileIndex tile);
#ifndef DOXYGEN_AI_DOCS
/** /**
* Internal function to help BuildTunnel in case of road. * Internal function to help BuildTunnel in case of road.
* @api -all
*/ */
static bool _BuildTunnelRoad1(); static bool _BuildTunnelRoad1();
/** /**
* Internal function to help BuildTunnel in case of road. * Internal function to help BuildTunnel in case of road.
* @api -all
*/ */
static bool _BuildTunnelRoad2(); static bool _BuildTunnelRoad2();
#endif /* DOXYGEN_AI_DOCS */
/** /**
* Builds a tunnel starting at start. The direction of the tunnel depends * Builds a tunnel starting at start. The direction of the tunnel depends