include: add missing comments for error types

Signed-off-by: Pablo de Lara <[email protected]>

Author: pablodelara

include/isal_crypto_api.h

@@ -57,31 +57,31 @@ extern "C" {
  * @brief Library error types
  */
 typedef enum {
-        ISAL_CRYPTO_ERR_NONE = 0,
-        ISAL_CRYPTO_ERR_NULL_SRC = 2000,
-        ISAL_CRYPTO_ERR_NULL_DST,
-        ISAL_CRYPTO_ERR_NULL_CTX,
-        ISAL_CRYPTO_ERR_NULL_MGR,
-        ISAL_CRYPTO_ERR_NULL_KEY,
-        ISAL_CRYPTO_ERR_NULL_EXP_KEY,
-        ISAL_CRYPTO_ERR_NULL_IV,
-        ISAL_CRYPTO_ERR_NULL_AUTH,
-        ISAL_CRYPTO_ERR_NULL_AAD,
-        ISAL_CRYPTO_ERR_CIPH_LEN,
-        ISAL_CRYPTO_ERR_AUTH_TAG_LEN,
-        ISAL_CRYPTO_ERR_INVALID_FLAGS,
-        ISAL_CRYPTO_ERR_ALREADY_PROCESSING,
-        ISAL_CRYPTO_ERR_ALREADY_COMPLETED,
-        ISAL_CRYPTO_ERR_XTS_NULL_TWEAK,
-        ISAL_CRYPTO_ERR_XTS_SAME_KEYS,
-        ISAL_CRYPTO_ERR_SELF_TEST,
-        ISAL_CRYPTO_ERR_FIPS_INVALID_ALGO,
-        ISAL_CRYPTO_ERR_WINDOW_SIZE,
-        ISAL_CRYPTO_ERR_NULL_OFFSET,
-        ISAL_CRYPTO_ERR_NULL_MATCH,
-        ISAL_CRYPTO_ERR_NULL_MASK,
-        ISAL_CRYPTO_ERR_NULL_INIT_VAL,
-        ISAL_CRYPTO_ERR_FIPS_DISABLED, //!< FIPS Mode is not enabled
+        ISAL_CRYPTO_ERR_NONE = 0,           //!< No error
+        ISAL_CRYPTO_ERR_NULL_SRC = 2000,    //!< Null source pointer
+        ISAL_CRYPTO_ERR_NULL_DST,           //!< Null destination pointer
+        ISAL_CRYPTO_ERR_NULL_CTX,           //!< Null context pointer
+        ISAL_CRYPTO_ERR_NULL_MGR,           //!< Null manager pointer
+        ISAL_CRYPTO_ERR_NULL_KEY,           //!< Null key pointer
+        ISAL_CRYPTO_ERR_NULL_EXP_KEY,       //!< Null expanded key pointer
+        ISAL_CRYPTO_ERR_NULL_IV,            //!< Null IV pointer
+        ISAL_CRYPTO_ERR_NULL_AUTH,          //!< Null authentication tag pointer
+        ISAL_CRYPTO_ERR_NULL_AAD,           //!< Null AAD pointer
+        ISAL_CRYPTO_ERR_CIPH_LEN,           //!< Invalid cipher length
+        ISAL_CRYPTO_ERR_AUTH_TAG_LEN,       //!< Invalid authentication tag length
+        ISAL_CRYPTO_ERR_INVALID_FLAGS,      //!< Invalid context flags
+        ISAL_CRYPTO_ERR_ALREADY_PROCESSING, //!< Job already processing
+        ISAL_CRYPTO_ERR_ALREADY_COMPLETED,  //!< Job already completed
+        ISAL_CRYPTO_ERR_XTS_NULL_TWEAK,     //!< Null AES-XTS tweak pointer
+        ISAL_CRYPTO_ERR_XTS_SAME_KEYS,      //!< Equal AES-XTS k1 and k2 keys
+        ISAL_CRYPTO_ERR_SELF_TEST,          //!< Self tests
+        ISAL_CRYPTO_ERR_FIPS_INVALID_ALGO,  //!< Non NIST-approved algorithm
+        ISAL_CRYPTO_ERR_WINDOW_SIZE,        //!< Invalid Rolling hash window size
+        ISAL_CRYPTO_ERR_NULL_OFFSET,        //!< Null Rolling hash offset pointer
+        ISAL_CRYPTO_ERR_NULL_MATCH,         //!< Null Rolling hash match pointer
+        ISAL_CRYPTO_ERR_NULL_MASK,          //!< Null Rolling hash mask pointer
+        ISAL_CRYPTO_ERR_NULL_INIT_VAL,      //!< Null Rolling hash initial value pointer
+        ISAL_CRYPTO_ERR_FIPS_DISABLED,      //!< FIPS Mode is not enabled
         /* add new error types above this comment */
         ISAL_CRYPTO_ERR_MAX /* don't move this one */
 } ISAL_CRYPTO_ERROR;