diff 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
line wrap: on
line diff
--- a/common/binverify.h	Thu Sep 25 17:37:03 2014 +0200
+++ b/common/binverify.h	Thu Sep 25 17:58:12 2014 +0200
@@ -24,15 +24,21 @@
  * @brief Result of a verification
  */
 typedef enum {
-    VerifyValid = 100, /*! Could be read and signature matched */
-    VerifyUnknownError = 1, /*! The expected unexpected */
-    VerifyInvalidSignature = 4, /*! Signature was invalid */
-    VerifyInvalidCertificate = 5, /*! Certificate mismatch */
-    VerifyReadFailed = 6, /*! File exists but could not read the file */
+    /*! Could be read and signature matched */
+    VerifyValid = 100,
+    /*! The expected unexpected */
+    VerifyUnknownError = 1,
+    /*! Signature was invalid */
+    VerifyInvalidSignature = 4,
+    /*! Certificate mismatch */
+    VerifyInvalidCertificate = 5,
+    /*! File exists but could not read the file */
+    VerifyReadFailed = 6,
 } verify_result;
 
 /**
- * A structure containing a verify_result and a reference to the
+ * @struct bin_verify_result
+ * @brief A structure containing a verify_result and a reference to the
  * verified file.
  */
 typedef struct {

http://wald.intevation.org/projects/trustbridge/