X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afs.h;h=8beca5aefcd0b9d06aed05e915877a2c5104a1a8;hp=c2a8f2e9435b2dfaebe784167ab6255e42529bae;hb=62f16302b6cdb35de8b33894858cec81b34639be;hpb=b07867b2fdcdfbbf1a66d66e2c6283cf68203fa9

diff --git a/afs.h b/afs.h
index c2a8f2e9..8beca5ae 100644
--- a/afs.h
+++ b/afs.h
@@ -1,8 +1,4 @@
-/*
- * Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>
- *
- * Licensed under the GPL v2. For licencing details see COPYING.
- */
+/* Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
 
 /** \file afs.h Exported symbols of the audio file selector. */
 
@@ -141,7 +137,7 @@ struct pattern_match_data {
 	unsigned loop_col_num;
 	/** Data from this column is matched against the given patterns. */
 	unsigned match_col_num;
-	/** \see pattern_match_flags. */
+	/** \see \ref pattern_match_flags. */
 	unsigned pm_flags;
 	/** This value is passed verbatim to fnmatch(). */
 	int fnmatch_flags;
@@ -165,6 +161,14 @@ struct afs_callback_arg {
 	struct osl_object query;
 	/** Will be written on band SBD_OUTPUT, fully buffered. */
 	struct para_buffer pbout;
+	/**
+	 * Convenience pointer for the deserialized parse result.
+	 *
+	 * Most afs command handlers call \ref send_lls_callback_request() to
+	 * serialize the parse result of the subcommand and pass it to the
+	 * callback. In afs context a pointer to the deserialized parse result
+	 * is stored here.
+	 */
 	struct lls_parse_result *lpr;
 };
 
@@ -174,7 +178,7 @@ struct afs_callback_arg {
  * Therefore afs commands typically consist of two functions: The command
  * handler and the corresponding callback function that runs in afs context.
  *
- * \sa send_callback_request().
+ * \sa \ref send_callback_request().
  */
 typedef int afs_callback(struct afs_callback_arg *aca);
 
@@ -216,7 +220,7 @@ _static_inline_ int afs_max_size_handler(char *buf, size_t size, void *private)
 	return pass_buffer_as_shm(amshd->fd, amshd->band, buf, size);
 }
 
-__noreturn void afs_init(uint32_t cookie, int socket_fd);
+__noreturn void afs_init(int socket_fd);
 __must_check int afs_event(enum afs_events event, struct para_buffer *pb,
 	void *data);
 int send_callback_request(afs_callback *f, struct osl_object *query,