afs: Improve documentation of callback_result_handler.
authorAndre Noll <maan@tuebingen.mpg.de>
Sun, 16 Jul 2017 00:07:48 +0000 (02:07 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Sun, 16 Jul 2017 12:55:52 +0000 (14:55 +0200)
The old text was rather incomprehensive ("chunks to data").

afs.h

diff --git a/afs.h b/afs.h
index 879331e..c2a8f2e 100644 (file)
--- a/afs.h
+++ b/afs.h
@@ -179,11 +179,9 @@ struct afs_callback_arg {
 typedef int afs_callback(struct afs_callback_arg *aca);
 
 /**
- * Callbacks send chunks to data back to the command handler. Pointers to
- * this type of function are used by \ref send_callback_request and friends
- * to deal with the data in the command handler process.
- *
- * \sa \ref send_callback_request().
+ * Some AFS callbacks need to send data back to the command handler. Pointers
+ * to this type of function are passed to \ref send_callback_request() and
+ * related functions to dispatch the data in the command handler process.
  */
 typedef int callback_result_handler(struct osl_object *result, uint8_t band, void *private);
 int afs_cb_result_handler(struct osl_object *result, uint8_t band, void *private);