diff options
author | truebrain <truebrain@openttd.org> | 2011-11-29 23:27:26 +0000 |
---|---|---|
committer | truebrain <truebrain@openttd.org> | 2011-11-29 23:27:26 +0000 |
commit | 4d91f645c15bb3128adf969afcf7f15bd0f14fa0 (patch) | |
tree | 8ccc602deda6aa29bedcd19f697558348e7af3d6 /src/script/api/script_log.hpp | |
parent | 2c877b074ed656a6cf1d4d4e415cce407980add5 (diff) | |
download | openttd-4d91f645c15bb3128adf969afcf7f15bd0f14fa0.tar.xz |
(svn r23370) -Add: support @api tag in API header files, to select which API should receive the defined classes and functions
Diffstat (limited to 'src/script/api/script_log.hpp')
-rw-r--r-- | src/script/api/script_log.hpp | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/src/script/api/script_log.hpp b/src/script/api/script_log.hpp index ba5a5f025..a3a1cd9bf 100644 --- a/src/script/api/script_log.hpp +++ b/src/script/api/script_log.hpp @@ -16,6 +16,7 @@ /** * Class that handles all log related functions. + * @api ai */ class ScriptLog : public ScriptObject { /* ScriptController needs access to Enum and Log, in order to keep the flow from @@ -23,10 +24,10 @@ class ScriptLog : public ScriptObject { friend class ScriptController; public: -#ifndef EXPORT_SKIP /** * Log levels; The value is also feed to DEBUG() lvl. * This has no use for you, as AI writer. + * @api -all */ enum ScriptLogType { LOG_SQ_ERROR = 0, ///< Squirrel printed an error. @@ -39,6 +40,7 @@ public: /** * Internal representation of the log-data inside the AI. * This has no use for you, as AI writer. + * @api -all */ struct LogData { char **lines; ///< The log-lines. @@ -47,7 +49,6 @@ public: int pos; ///< Current position in lines. int used; ///< Total amount of used log-lines. }; -#endif /* EXPORT_SKIP */ /** * Print an Info message to the logs. @@ -67,13 +68,11 @@ public: */ static void Error(const char *message); -#ifndef EXPORT_SKIP /** * Free the log pointer. - * @note DO NOT CALL YOURSELF; leave it to the internal AI programming. + * @api -all */ static void FreeLogPointer(); -#endif /* EXPORT_SKIP */ private: /** |