Add documentation of enum blob_table_columns.

[paraslash.git] / afs.h

diff --git a/afs.h b/afs.h
index 9294ccfe6e864aa0ff624aff8e80d4742d622eea..97bc03329e4c940d16428acea2291126eb6bb9bb 100644 (file)
--- a/afs.h
+++ b/afs.h
@@ -28,7 +28,6 @@ enum afs_table_flags {TBLFLAG_SKIP_CREATE};
 
 struct table_info {
        const struct osl_table_description *desc;
-       struct osl_table *table;
        enum afs_table_flags flags;
 };
 
@@ -126,6 +125,8 @@ void close_current_mood(void);
 int mood_update_audio_file(const struct osl_row *aft_row, struct afs_info *old_afsi);
 int reload_current_mood(void);
 int mood_delete_audio_file(const struct osl_row *aft_row);
+int mood_check_callback(__a_unused const struct osl_object *query,
+       struct osl_object *result);
 
 
 /* playlist */
@@ -143,7 +144,7 @@ int playlist_check_callback(__a_unused const struct osl_object *query,
        int table_name ## _init(struct table_info *ti, const char *db); \
        void table_name ## _shutdown(enum osl_close_flags flags); \
        int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
-       int cmd_prefix ## _get_name_and_def_by_row(struct osl_row *row, \
+       int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
                char **name, struct osl_object *def); \
        extern struct osl_table *table_name ## _table;
 
@@ -152,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, \