Codechange: [Script] Document relation between ScriptErrorType and ErrorMessages enums

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

src/script/api/script_error.hpp

@@ -120,6 +120,8 @@ public:
 
 	/**
 	 * All general related error messages.
+	 *
+	 * @see ScriptErrorType
 	 */
 	enum ErrorMessages {
 		/** Initial error value */

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

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

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

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

src/script/api/script_sign.hpp

@@ -21,6 +21,8 @@ class ScriptSign : public ScriptObject {
 public:
 	/**
 	 * All sign related error messages.
+	 *
+	 * @see ScriptErrorType
 	 */
 	enum ErrorMessages {
 

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

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 {
 

src/script/api/script_tunnel.hpp

@@ -20,6 +20,8 @@ class ScriptTunnel : public ScriptObject {
 public:
 	/**
 	 * All tunnel related errors.
+	 *
+	 * @see ScriptErrorType
 	 */
 	enum ErrorMessages {
 

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

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

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