From 04cc0c8125dac493624e898fbac3016964ff77f1 Mon Sep 17 00:00:00 2001 From: frosch Date: Sun, 24 Mar 2024 18:48:24 +0100 Subject: [PATCH] Codechange: [Script] Document relation between ScriptErrorType and ErrorMessages enums --- src/script/api/script_bridge.hpp | 2 ++ src/script/api/script_error.hpp | 2 ++ src/script/api/script_marine.hpp | 2 ++ src/script/api/script_order.hpp | 2 ++ src/script/api/script_rail.hpp | 2 ++ src/script/api/script_road.hpp | 2 ++ src/script/api/script_sign.hpp | 2 ++ src/script/api/script_station.hpp | 2 ++ src/script/api/script_tile.hpp | 2 ++ src/script/api/script_tunnel.hpp | 2 ++ src/script/api/script_types.hpp | 7 ++++++- src/script/api/script_vehicle.hpp | 2 ++ src/script/api/script_waypoint.hpp | 2 ++ 13 files changed, 30 insertions(+), 1 deletion(-) diff --git a/src/script/api/script_bridge.hpp b/src/script/api/script_bridge.hpp index 01f52a55bd..964341244a 100644 --- a/src/script/api/script_bridge.hpp +++ b/src/script/api/script_bridge.hpp @@ -20,6 +20,8 @@ class ScriptBridge : public ScriptObject { public: /** * All bridge related error messages. + * + * @see ScriptErrorType */ enum ErrorMessages { /** Base for bridge related errors */ diff --git a/src/script/api/script_error.hpp b/src/script/api/script_error.hpp index 0fe7d92d56..84f2d6e86f 100644 --- a/src/script/api/script_error.hpp +++ b/src/script/api/script_error.hpp @@ -120,6 +120,8 @@ public: /** * All general related error messages. + * + * @see ScriptErrorType */ enum ErrorMessages { /** Initial error value */ diff --git a/src/script/api/script_marine.hpp b/src/script/api/script_marine.hpp index e6d5a2600b..7337c8df12 100644 --- a/src/script/api/script_marine.hpp +++ b/src/script/api/script_marine.hpp @@ -20,6 +20,8 @@ class ScriptMarine : public ScriptObject { public: /** * All marine related error messages. + * + * @see ScriptErrorType */ enum ErrorMessages { /** Base for marine related errors */ diff --git a/src/script/api/script_order.hpp b/src/script/api/script_order.hpp index d3e7066cd5..752136134e 100644 --- a/src/script/api/script_order.hpp +++ b/src/script/api/script_order.hpp @@ -21,6 +21,8 @@ class ScriptOrder : public ScriptObject { public: /** * All order related error messages. + * + * @see ScriptErrorType */ enum ErrorMessages { /** Base for all order related errors */ diff --git a/src/script/api/script_rail.hpp b/src/script/api/script_rail.hpp index b17b86d7a3..2a55a72048 100644 --- a/src/script/api/script_rail.hpp +++ b/src/script/api/script_rail.hpp @@ -22,6 +22,8 @@ class ScriptRail : public ScriptObject { public: /** * All rail related error messages. + * + * @see ScriptErrorType */ enum ErrorMessages { /** Base for rail building / maintaining errors */ diff --git a/src/script/api/script_road.hpp b/src/script/api/script_road.hpp index 007c44adce..46f75ae2f9 100644 --- a/src/script/api/script_road.hpp +++ b/src/script/api/script_road.hpp @@ -22,6 +22,8 @@ class ScriptRoad : public ScriptObject { public: /** * All road related error messages. + * + * @see ScriptErrorType */ enum ErrorMessages { /** Base for road building / maintaining errors */ diff --git a/src/script/api/script_sign.hpp b/src/script/api/script_sign.hpp index 1569ad9932..3e9d0c8ff8 100644 --- a/src/script/api/script_sign.hpp +++ b/src/script/api/script_sign.hpp @@ -21,6 +21,8 @@ class ScriptSign : public ScriptObject { public: /** * All sign related error messages. + * + * @see ScriptErrorType */ enum ErrorMessages { diff --git a/src/script/api/script_station.hpp b/src/script/api/script_station.hpp index 4f705a518a..6837eea418 100644 --- a/src/script/api/script_station.hpp +++ b/src/script/api/script_station.hpp @@ -22,6 +22,8 @@ class ScriptStation : public ScriptBaseStation { public: /** * All station related error messages. + * + * @see ScriptErrorType */ enum ErrorMessages { /** Base for station related errors */ diff --git a/src/script/api/script_tile.hpp b/src/script/api/script_tile.hpp index de476ffb69..8abf47a793 100644 --- a/src/script/api/script_tile.hpp +++ b/src/script/api/script_tile.hpp @@ -23,6 +23,8 @@ class ScriptTile : public ScriptObject { public: /** * Error messages related to modifying tiles. + * + * @see ScriptErrorType */ enum ErrorMessages { diff --git a/src/script/api/script_tunnel.hpp b/src/script/api/script_tunnel.hpp index 5f226370b4..2331d8b313 100644 --- a/src/script/api/script_tunnel.hpp +++ b/src/script/api/script_tunnel.hpp @@ -20,6 +20,8 @@ class ScriptTunnel : public ScriptObject { public: /** * All tunnel related errors. + * + * @see ScriptErrorType */ enum ErrorMessages { diff --git a/src/script/api/script_types.hpp b/src/script/api/script_types.hpp index bd925079c0..f020427fa2 100644 --- a/src/script/api/script_types.hpp +++ b/src/script/api/script_types.hpp @@ -135,6 +135,11 @@ typedef uint32_t TileIndex; ///< The ID of a map location. typedef uint16_t TownID; ///< The ID of a town. typedef uint32_t VehicleID; ///< The ID of a vehicle. -typedef uint ScriptErrorType;///< The types of errors inside the script framework. +/** + * The types of errors inside the script framework. + * + * Possible value are defined inside each API class in an ErrorMessages enum. + */ +typedef uint ScriptErrorType; #endif /* SCRIPT_TYPES_HPP */ diff --git a/src/script/api/script_vehicle.hpp b/src/script/api/script_vehicle.hpp index bd6d79ebcc..d9c5309956 100644 --- a/src/script/api/script_vehicle.hpp +++ b/src/script/api/script_vehicle.hpp @@ -20,6 +20,8 @@ class ScriptVehicle : public ScriptObject { public: /** * All vehicle related error messages. + * + * @see ScriptErrorType */ enum ErrorMessages { /** Base for vehicle related errors */ diff --git a/src/script/api/script_waypoint.hpp b/src/script/api/script_waypoint.hpp index 9dada43966..62f9e6c875 100644 --- a/src/script/api/script_waypoint.hpp +++ b/src/script/api/script_waypoint.hpp @@ -22,6 +22,8 @@ class ScriptWaypoint : public ScriptBaseStation { public: /** * All waypoint related error messages. + * + * @see ScriptErrorType */ enum ErrorMessages { /** Base for waypoint related errors */