Add documentation of enum blob_table_columns.
authorAndre Noll <maan@systemlinux.org>
Wed, 26 Sep 2007 14:51:29 +0000 (16:51 +0200)
committerAndre Noll <maan@systemlinux.org>
Wed, 26 Sep 2007 14:51:29 +0000 (16:51 +0200)
afs.h

diff --git a/afs.h b/afs.h
index e12891c..97bc033 100644 (file)
--- a/afs.h
+++ b/afs.h
@@ -153,7 +153,18 @@ DECLARE_BLOB_SYMBOLS(images, img);
 DECLARE_BLOB_SYMBOLS(moods, mood);
 DECLARE_BLOB_SYMBOLS(playlists, pl);
 
-enum blob_table_columns {BLOBCOL_ID, BLOBCOL_NAME, BLOBCOL_DEF, NUM_BLOB_COLUMNS};
+/** The columns of an abstract blob table. */
+enum blob_table_columns {
+       /** The identifier, a positive integer that never repeats. */
+       BLOBCOL_ID,
+       /** The unique name of the blob. */
+       BLOBCOL_NAME,
+       /** The actual blob contents. */
+       BLOBCOL_DEF,
+       /** A blob table has that many columns. */
+       NUM_BLOB_COLUMNS
+};
+
 #define DEFINE_BLOB_TABLE_DESC(table_name) \
        struct osl_table_description table_name ## _table_desc = { \
                .name = #table_name, \