From a2222a2ddac2f12d38ae62bc7a769ed6d1ae1b46 Mon Sep 17 00:00:00 2001 From: Ben Pfaff Date: Fri, 29 Apr 2005 21:32:18 +0000 Subject: [PATCH] Add function comments. --- src/vars-atr.c | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/vars-atr.c b/src/vars-atr.c index 9ed5fcbc..a3024d0c 100644 --- a/src/vars-atr.c +++ b/src/vars-atr.c @@ -36,6 +36,9 @@ #include "debug-print.h" +/* Assign auxiliary data AUX to variable V, which must not + already have auxiliary data. Before V's auxiliary data is + cleared, AUX_DTOR(V) will be called. */ void * var_attach_aux (struct variable *v, void *aux, void (*aux_dtor) (struct variable *)) @@ -47,6 +50,8 @@ var_attach_aux (struct variable *v, return aux; } +/* Remove auxiliary data, if any, from V, and returns it, without + calling any associated destructor. */ void * var_detach_aux (struct variable *v) { @@ -56,6 +61,8 @@ var_detach_aux (struct variable *v) return aux; } +/* Clears auxiliary data, if any, from V, and calls any + associated destructor. */ void var_clear_aux (struct variable *v) { @@ -68,6 +75,9 @@ var_clear_aux (struct variable *v) } } +/* This function is appropriate for use an auxiliary data + destructor (passed as AUX_DTOR to var_attach_aux()) for the + case where the auxiliary data should be passed to free(). */ void var_dtor_free (struct variable *v) { -- 2.30.2