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

replace/41b28d7194a279bdc17475d4fbe2ea6ec885a466
truebrain 13 years ago
parent 4d91f645c1
commit 549e072041

@ -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
#---------------------------------------------------------------------------

@ -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

@ -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";

@ -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.

@ -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.

@ -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 */

@ -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.

@ -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

Loading…
Cancel
Save