afs: Improve documentation of callback_result_handler.

[paraslash.git] / afs.h

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