diff Core/Enumerations.h @ 1578:09715095fc53

cont
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 25 Aug 2015 15:33:36 +0200
parents 7aac0cddd42e
children b93c398f934d
line wrap: on
line diff
--- a/Core/Enumerations.h	Tue Aug 25 15:10:45 2015 +0200
+++ b/Core/Enumerations.h	Tue Aug 25 15:33:36 2015 +0200
@@ -41,36 +41,38 @@
     Endianness_Little
   };
 
+  // This enumeration is autogenerated by the script
+  // "Resources/GenerateErrorCodes.py"
   enum ErrorCode
   {
-    ErrorCode_Custom = -1,
-    ErrorCode_Success = 0,
-    ErrorCode_InternalError = 1,
-    ErrorCode_NotImplemented = 2,
-    ErrorCode_ParameterOutOfRange = 3,
-    ErrorCode_NotEnoughMemory = 4,
-    ErrorCode_BadParameterType = 5,
-    ErrorCode_BadSequenceOfCalls = 6,
-    ErrorCode_InexistentItem = 7,
-    ErrorCode_BadRequest = 8,
-    ErrorCode_NetworkProtocol = 9,
-    ErrorCode_SystemCommand = 10,
-    ErrorCode_Database = 11,
-    ErrorCode_UriSyntax = 12,
-    ErrorCode_InexistentFile = 13,
-    ErrorCode_CannotWriteFile = 14,
-    ErrorCode_BadFileFormat = 15,
-    ErrorCode_Timeout = 16,
-    ErrorCode_UnknownResource = 17,
-    ErrorCode_IncompatibleDatabaseVersion = 18,
-    ErrorCode_FullStorage = 19,
-    ErrorCode_CorruptedFile = 20,
-    ErrorCode_InexistentTag = 21,
-    ErrorCode_ReadOnly = 22,
-    ErrorCode_IncompatibleImageFormat = 23,
-    ErrorCode_IncompatibleImageSize = 24,
-    ErrorCode_SharedLibrary = 25,
-    ErrorCode_Plugin = 26
+    ErrorCode_Custom = -1    /*!< Custom error, see the attached error message */,
+    ErrorCode_Success = 0    /*!< Success */,
+    ErrorCode_InternalError = 1    /*!< Internal error */,
+    ErrorCode_NotImplemented = 2    /*!< Not implemented yet */,
+    ErrorCode_ParameterOutOfRange = 3    /*!< Parameter out of range */,
+    ErrorCode_NotEnoughMemory = 4    /*!< Not enough memory */,
+    ErrorCode_BadParameterType = 5    /*!< Bad type for a parameter */,
+    ErrorCode_BadSequenceOfCalls = 6    /*!< Bad sequence of calls */,
+    ErrorCode_InexistentItem = 7    /*!< Accessing an inexistent item */,
+    ErrorCode_BadRequest = 8    /*!< Bad request */,
+    ErrorCode_NetworkProtocol = 9    /*!< Error in the network protocol */,
+    ErrorCode_SystemCommand = 10    /*!< Error while calling a system command */,
+    ErrorCode_Database = 11    /*!< Error with the database engine */,
+    ErrorCode_UriSyntax = 12    /*!< Badly formatted URI */,
+    ErrorCode_InexistentFile = 13    /*!< Inexistent file */,
+    ErrorCode_CannotWriteFile = 14    /*!< Cannot write to file */,
+    ErrorCode_BadFileFormat = 15    /*!< Bad file format */,
+    ErrorCode_Timeout = 16    /*!< Timeout */,
+    ErrorCode_UnknownResource = 17    /*!< Unknown resource */,
+    ErrorCode_IncompatibleDatabaseVersion = 18    /*!< Incompatible version of the database */,
+    ErrorCode_FullStorage = 19    /*!< The file storage is full */,
+    ErrorCode_CorruptedFile = 20    /*!< Corrupted file (inconsistent MD5 hash) */,
+    ErrorCode_InexistentTag = 21    /*!< Inexistent tag */,
+    ErrorCode_ReadOnly = 22    /*!< Cannot modify a read-only data structure */,
+    ErrorCode_IncompatibleImageFormat = 23    /*!< Incompatible format of the images */,
+    ErrorCode_IncompatibleImageSize = 24    /*!< Incompatible size of the images */,
+    ErrorCode_SharedLibrary = 25    /*!< Error while using a shared library (plugin) */,
+    ErrorCode_Plugin = 26    /*!< Error encountered inside a plugin */
   };
 
   enum LogLevel