From: Andre Noll <maan@tuebingen.mpg.de>
Date: Sun, 16 Jul 2017 00:07:48 +0000 (+0200)
Subject: afs: Improve documentation of callback_result_handler.
X-Git-Tag: v0.6.1~61
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=b07867b2fdcdfbbf1a66d66e2c6283cf68203fa9;hp=ff3e6a8cc3b5fc13cf32f2a89843820d26ff0197

afs: Improve documentation of callback_result_handler.

The old text was rather incomprehensive ("chunks to data").
---

diff --git a/afs.h b/afs.h
index 879331ec..c2a8f2e9 100644
--- 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);