From 5661fe0c66af9a103bef356b1b45b3b6e386ea38 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Sun, 11 Jan 2015 14:24:14 +0100 Subject: [PATCH] afs.c: Improve documentation of send_option_arg_callback_request(). The new text tries to emphasize that arbitrary structures may be passed from the command handler to the callback (*not* the parent process). --- afs.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/afs.c b/afs.c index 68afec6c..ab2cc74d 100644 --- a/afs.c +++ b/afs.c @@ -292,10 +292,10 @@ out: * \param result_handler See \ref send_callback_request. * \param private_result_data See \ref send_callback_request. * - * Some commands have a couple of options that are parsed in child context for - * syntactic correctness and are stored in a special options structure for that - * command. This function allows to pass such a structure together with a list - * of further arguments (often a list of audio files) to the parent process. + * Some command handlers pass command-specific options to a callback, together + * with a list of further arguments (often a list of audio files). This + * function allows to pass an arbitrary structure (given as an osl object) and + * a usual argument vector to the specified callback. * * \return The return value of the underlying call to \ref * send_callback_request(). -- 2.39.2