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_error.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_error.hpp')
| -rw-r--r-- | src/script/api/script_error.hpp | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/src/script/api/script_error.hpp b/src/script/api/script_error.hpp index cbc74005a..53c084fad 100644 --- a/src/script/api/script_error.hpp +++ b/src/script/api/script_error.hpp @@ -40,6 +40,7 @@ /** * Class that handles all error related functions. + * @api ai */ class ScriptError : public ScriptObject { public: @@ -142,10 +143,9 @@ public: */ static char *GetLastErrorString(); -#ifndef EXPORT_SKIP /** * Get the error based on the OpenTTD StringID. - * @note DO NOT INVOKE THIS METHOD YOURSELF! + * @api -all * @param internal_string_id The string to convert. * @return The NoAI equivalent error message. */ @@ -153,7 +153,7 @@ public: /** * Map an internal OpenTTD error message to its NoAI equivalent. - * @note DO NOT INVOKE THIS METHOD YOURSELF! The calls are autogenerated. + * @api -all * @param internal_string_id The OpenTTD StringID used for an error. * @param ai_error_msg The NoAI equivalent error message. */ @@ -161,12 +161,11 @@ public: /** * Map an internal OpenTTD error message to its NoAI equivalent. - * @note DO NOT INVOKE THIS METHOD YOURSELF! The calls are autogenerated. + * @api -all * @param ai_error_msg The NoAI error message representation. * @param message The string representation of this error message, used for debug purposes. */ static void RegisterErrorMapString(ScriptErrorType ai_error_msg, const char *message); -#endif /* EXPORT_SKIP */ private: typedef std::map<StringID, ScriptErrorType> ScriptErrorMap; ///< The type for mapping between error (internal OpenTTD) StringID to the AI error type. |