[PATCH 3 of 5] Doxygen comments for list_status_t

[Wald Commits]

# HG changeset patch
# User Andre Heinecke <aheinecke at intevation.de>
# Date 1401186455 0
# Node ID bf54c9fc0d630aa9bcf1051cd059dbdfbe0433d9
# Parent  4ccae6acfaec1ddca17d52de2e76cf2dad3f86e6
Doxygen comments for list_status_t

diff -r 4ccae6acfaec -r bf54c9fc0d63 common/listutil.h
--- a/common/listutil.h	Tue May 27 10:26:51 2014 +0000
+++ b/common/listutil.h	Tue May 27 10:27:35 2014 +0000
@@ -23,15 +23,15 @@
  * @brief Status of the List Operations
  */
 typedef enum {
-    Valid = 100, // Could be read and signature matched
-    UnknownError = 1, // The expected unexpected
-    TooLarge = 2, // Failed because the file exeeds the limit
-    InvalidFormat = 3, // File does not appear to be in list format
-    InvalidSignature = 4, // Signature was invalid
-    SeekFailed = 5, // Could not seek in the file
-    ReadFailed = 6, // File exists but could not read the file
-    IncompatibleVersion = 7, // The Format Version does not match
-    NoList = 8 // No list parsed
+    Valid = 100, /*! Could be read and signature matched */
+    UnknownError = 1, /*! The expected unexpected */
+    TooLarge = 2, /*! Failed because the file exeeds the limit */
+    InvalidFormat = 3, /*! File does not appear to be in list format */
+    InvalidSignature = 4, /*! Signature was invalid */
+    SeekFailed = 5, /*! Could not seek in the file */
+    ReadFailed = 6, /*! File exists but could not read the file */
+    IncompatibleVersion = 7, /*! The Format Version does not match */
+    NoList = 8 /*! No list parsed */
 } list_status_t;
 
 /* Definitions based on the format */