From: Andre Noll <maan@systemlinux.org>
Date: Wed, 26 Sep 2007 14:51:29 +0000 (+0200)
Subject: Add documentation of enum blob_table_columns.
X-Git-Tag: v0.3.0~343
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=0fa4e460a878fe80f937df5e1da31a33221e0ee0;p=paraslash.git

Add documentation of enum blob_table_columns.
---

diff --git a/afs.h b/afs.h
index e12891c6..97bc0332 100644
--- 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, \