afs.h: Add doxygen comments for enum afs_events and struct afs_table.
authorAndre Noll <maan@systemlinux.org>
Thu, 25 Oct 2007 17:28:34 +0000 (19:28 +0200)
committerAndre Noll <maan@systemlinux.org>
Thu, 25 Oct 2007 17:28:34 +0000 (19:28 +0200)
afs.h

diff --git a/afs.h b/afs.h
index b5e9d56..aecf627 100644 (file)
--- a/afs.h
+++ b/afs.h
@@ -4,7 +4,7 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file afs.h Exported symbos of the audio file selector. */
+/** \file afs.h Exported symbols of the audio file selector. */
 
 #include <regex.h>
 #include "osl.h"
@@ -26,19 +26,37 @@ struct afs_info {
        uint8_t audio_format_id;
 };
 
+/**
+ * Events caused by changes to an afs table.
+ *
+ * Whenever an afs table changes, an event is generated which causes afs to
+ * call the event handlers of all other tables. For example, if an audio file
+ * is added, the event handler of the mood table checks the new file for
+ * admissibility.
+ */
 enum afs_events {
+       /** An attribute was added. */
        ATTRIBUTE_ADD,
+       /** An attribute was renamed. */
        ATTRIBUTE_RENAME,
+       /** An attribute was removed. */
        ATTRIBUTE_REMOVE,
+       /** The afs info struct of an audio file changed. */
        AFSI_CHANGE,
+       /** The afh info struct of an audio file changed. */
        AFHI_CHANGE,
+       /** An audio file was renamed. */
        AUDIO_FILE_RENAME,
+       /** An audio file was added. */
        AUDIO_FILE_ADD,
+       /** An audio file is about to be removed. */
        AUDIO_FILE_REMOVE,
+       /** A new blob was added. */
        BLOB_ADD,
+       /** A blob was renamed. */
        BLOB_RENAME,
+       /** A blob is about to be removed. */
        BLOB_REMOVE,
-
 };
 
 struct rmatt_event_data {
@@ -57,12 +75,19 @@ struct afsi_change_event_data {
        struct afs_info *old_afsi;
 };
 
+/** Function pointers for table handling.  */
 struct afs_table {
+       /** Initializes the other pointers in this struct. */
        void (*init)(struct afs_table *t);
+       /** The name of this table. */
        const char *name;
+       /** Gets called on startup and on \p SIGHUP. */
        int (*open)(const char *base_dir);
+       /** Gets called on shutdown and on \p SIGHUP. */
        void (*close)(void);
+       /** Called by the \a init afs command. */
        int (*create)(const char *);
+       /** Handles afs events. */
        int (*event_handler)(enum afs_events event, struct para_buffer *pb,
                void *data);
        /* int *(check)() */
@@ -186,6 +211,7 @@ int playlist_check_callback(__a_unused const struct osl_object *query,
 #define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
 
 
+/** Define exported functions and a table pointer for an osl blob table. */
 #define DECLARE_BLOB_SYMBOLS(table_name, cmd_prefix) \
        void table_name ## _init(struct afs_table *t); \
        int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
@@ -214,6 +240,7 @@ enum blob_table_columns {
        NUM_BLOB_COLUMNS
 };
 
+/** Define an osl table decription for a blob table. */
 #define DEFINE_BLOB_TABLE_DESC(table_name) \
        struct osl_table_description table_name ## _table_desc = { \
                .name = #table_name, \
@@ -222,8 +249,10 @@ enum blob_table_columns {
                .column_descriptions = blob_cols \
        };
 
+/** Define a pointer to an osl blob table with a canonical name. */
 #define DEFINE_BLOB_TABLE_PTR(table_name) struct osl_table *table_name ## _table;
 
+/** Define a blob table. */
 #define INIT_BLOB_TABLE(table_name) \
        DEFINE_BLOB_TABLE_DESC(table_name); \
        DEFINE_BLOB_TABLE_PTR(table_name);