1
0
mirror of https://github.com/rkd77/elinks.git synced 2024-09-29 03:17:53 -04:00

Document the parameters of change_hook_T.

This commit is contained in:
Kalle Olavi Niemitalo 2007-01-27 20:31:15 +02:00 committed by Kalle Olavi Niemitalo
parent 2e5488ba3d
commit 6a1d21441e

View File

@ -105,7 +105,19 @@ union option_value {
unsigned char *string;
};
typedef int (*change_hook_T)(struct session *, struct option *current,
/* @session is the session via which the user changed the options,
* or NULL if not known. Because the options are currently not
* session-specific, it is best to ignore this parameter. In a future
* version of ELinks, this parameter might mean the session to which
* the changed options apply.
*
* @current is the option whose change hook is being called. It is
* never NULL.
*
* @changed is the option that was changed, or NULL if multiple
* descendants of @current may have been changed. */
typedef int (*change_hook_T)(struct session *session, struct option *current,
struct option *changed);
struct option {