dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(svn r23370) -Add: support @api tag in API header files, to select which API should receive the defined classes and functions

Browse Source
This commit is contained in:
truebrain
2011-11-29 23:27:26 +00:00
parent 2c877b074e
commit 4d91f645c1
52 changed files with 240 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/script/api/script_error.hpp
View File

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