Add more documentation.

[paraslash.git] / afs.h

diff --git a/afs.h b/afs.h
index 7167da49c821e74294e3df46b553333901a969f9..ab2db3aa1f90c561732abc34b528f0a7b20f1ebb 100644 (file)
--- a/afs.h
+++ b/afs.h
@@ -4,6 +4,8 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
+/** \file afs.h Exported symbos of the audio file selector. */
+
 #include <regex.h>
 #include "osl.h"
 #include "hash.h"
@@ -42,26 +44,39 @@ struct audio_file_data {
        struct osl_object map;
 };
 
+/** Flags passed to for_each_matching_row(). */
 enum pattern_match_flags {
+       /** Loop in reverse order. */
        PM_REVERSE_LOOP = 1,
+       /** If no pattern is given, loop over all rows. */
        PM_NO_PATTERN_MATCHES_EVERYTHING = 2,
+       /** If the data in match_column is the empty string, skip this row. */
        PM_SKIP_EMPTY_NAME = 4,
 };
 
+/** Structure passed to for_each_matching_row(). */
 struct pattern_match_data {
+       /** Loop over all rows in this table. */
        struct osl_table *table;
+       /** Determines the loop order. Must be an rbtree column. */
        unsigned loop_col_num;
+       /** Data from this column is matched against the given patterns. */
        unsigned match_col_num;
+       /** \see pattern_match_flags. */
        unsigned pm_flags;
+       /** This value is passed verbatim to fnmatch(). */
        int fnmatch_flags;
+       /** Null-terminated array of patterns. */
        struct osl_object patterns;
+       /** Data pointer passed to the action function. */
        void *data;
+       /** For each matching row, this function will be called. */
        int (*action)(struct osl_table *table, struct osl_row *row, const char *name, void *data);
 };
 
 /* afs */
 typedef int callback_function(const struct osl_object *, struct osl_object *);
-__noreturn int afs_init(uint32_t cookie, int socket_fd);
+__noreturn void afs_init(uint32_t cookie, int socket_fd);
 int send_callback_request(callback_function *f, struct osl_object *query,
        struct osl_object *result);
 int send_standard_callback_request(int argc, char * const * const argv,