From 77e4a76adad60c83811baf1c69fd413a6153528f Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Mon, 21 Nov 2022 13:57:17 +0100 Subject: [PATCH] afs.h: Improve documentation of typedefs. Doxygen expects the comments to consist of a one-line summary and an optional long description. --- afs.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/afs.h b/afs.h index 59c887a0..9a1d7d9c 100644 --- a/afs.h +++ b/afs.h @@ -169,6 +169,8 @@ struct afs_callback_arg { }; /** + * The "top half" of an afs command. + * * 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 @@ -179,9 +181,13 @@ struct afs_callback_arg { typedef int afs_callback(struct afs_callback_arg *aca); /** + * Dispatch the output of an afs callback. + * * 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. + * related functions to dispatch the data in the command handler process. Most + * (but not all) afs commands pass \ref afs_cb_result_handler(), which sends + * the output of the callback to the connected client. */ 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); -- 2.39.2