Merge commit 'remotes/fml/master'

[paraslash.git] / afs.h

diff --git a/afs.h b/afs.h
index eed17768c871c9c0a3841457a6f7762972ddf0a4..434570497041a760fac86f80e139156da4ae5e93 100644 (file)
--- a/afs.h
+++ b/afs.h
@@ -66,7 +66,7 @@ struct rmatt_event_data {
 
 
 struct afsi_change_event_data {
-       const struct osl_row *aft_row;
+       struct osl_row *aft_row;
        struct afs_info *old_afsi;
 };
 
@@ -110,13 +110,12 @@ struct ls_data {
 int make_status_items(struct ls_data *d, struct para_buffer *pb);
 void make_empty_status_items(char *buf);
 
+/** At most that many bytes will be passed from afs to para_server. */
 #define VERBOSE_LS_OUTPUT_SIZE 4096
 
-/*
- * Data about the current audio file, passed from afs to server.
- */
+/** Data about the current audio file, passed from afs to server. */
 struct audio_file_data {
-       /** Same info as ls -lv -p <current audio file>. */
+       /** Same info as ls -lv -p current audio_file. */
        char verbose_ls_output[VERBOSE_LS_OUTPUT_SIZE];
        /** The open file descriptor to the current audio file. */
        int fd;
@@ -161,6 +160,14 @@ struct pattern_match_data {
 };
 
 /* afs */
+/**
+ * Afs command handlers run as a process which is not related to the afs
+ * process, i.e. they can not change the address space of afs directly.
+ * 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().
+ */
 typedef int callback_function(const struct osl_object *, struct osl_object *);
 __noreturn void afs_init(uint32_t cookie, int socket_fd);
 void afs_event(enum afs_events event, struct para_buffer *pb,
@@ -175,7 +182,6 @@ int send_option_arg_callback_request(struct osl_object *options,
 int stdin_command(int fd, struct osl_object *arg_obj, callback_function *f,
                unsigned max_len, struct osl_object *result);
 int string_compare(const struct osl_object *obj1, const struct osl_object *obj2);
-int close_audio_file(struct audio_file_data *afd);
 int for_each_matching_row(struct pattern_match_data *pmd);
 
 /* score */
@@ -260,7 +266,7 @@ enum blob_table_columns {
        NUM_BLOB_COLUMNS
 };
 
-/** Define an osl table decription for a blob table. */
+/** Define an osl table description for a blob table. */
 #define DEFINE_BLOB_TABLE_DESC(table_name) \
        struct osl_table_description table_name ## _table_desc = { \
                .name = #table_name, \