afs.h: Add more documentation.

diff --git a/afs.h b/afs.h
index 4c171a8e08f2d3c91c1055363c9a457d09d98b30..c7fecd881ef3e9e98daac0ccaa3264d4343dc667 100644 (file)
--- a/afs.h
+++ b/afs.h
@@ -110,6 +110,7 @@ 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
 
 /*
@@ -161,6 +162,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,