Mercurial > trustbridge
comparison common/binverify.h @ 1255:2a1aa9df8f11
(issue133) Improve API documentation
| author | Andre Heinecke <andre.heinecke@intevation.de> |
|---|---|
| date | Thu, 25 Sep 2014 17:58:12 +0200 |
| parents | edbf5e5e88f4 |
| children | 28885e8c891f |
comparison
equal
deleted
inserted
replaced
| 1254:6d840341bc25 | 1255:2a1aa9df8f11 |
|---|---|
| 22 /** | 22 /** |
| 23 * @enum verify_result | 23 * @enum verify_result |
| 24 * @brief Result of a verification | 24 * @brief Result of a verification |
| 25 */ | 25 */ |
| 26 typedef enum { | 26 typedef enum { |
| 27 VerifyValid = 100, /*! Could be read and signature matched */ | 27 /*! Could be read and signature matched */ |
| 28 VerifyUnknownError = 1, /*! The expected unexpected */ | 28 VerifyValid = 100, |
| 29 VerifyInvalidSignature = 4, /*! Signature was invalid */ | 29 /*! The expected unexpected */ |
| 30 VerifyInvalidCertificate = 5, /*! Certificate mismatch */ | 30 VerifyUnknownError = 1, |
| 31 VerifyReadFailed = 6, /*! File exists but could not read the file */ | 31 /*! Signature was invalid */ |
| 32 VerifyInvalidSignature = 4, | |
| 33 /*! Certificate mismatch */ | |
| 34 VerifyInvalidCertificate = 5, | |
| 35 /*! File exists but could not read the file */ | |
| 36 VerifyReadFailed = 6, | |
| 32 } verify_result; | 37 } verify_result; |
| 33 | 38 |
| 34 /** | 39 /** |
| 35 * A structure containing a verify_result and a reference to the | 40 * @struct bin_verify_result |
| 41 * @brief A structure containing a verify_result and a reference to the | |
| 36 * verified file. | 42 * verified file. |
| 37 */ | 43 */ |
| 38 typedef struct { | 44 typedef struct { |
| 39 /*@{*/ | 45 /*@{*/ |
| 40 verify_result result; /**< the result of the verification */ | 46 verify_result result; /**< the result of the verification */ |