From 8dcf2544996af34f3c3d71116844352427787324 Mon Sep 17 00:00:00 2001 From: Pavel Machek Date: Wed, 7 Jun 2000 14:16:11 +0000 Subject: Even better documentation of filters. --- filter/filter.c | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) (limited to 'filter/filter.c') diff --git a/filter/filter.c b/filter/filter.c index 540ce13..d580b55 100644 --- a/filter/filter.c +++ b/filter/filter.c @@ -25,7 +25,7 @@ * * Filters use structure &f_val for its variables. Each &f_val * contains type and value. Types are constants prefixed with %T_. Few - * of types are special; %T_RETURN can be or-ed with type to indicate + * of types are special; %T_RETURN can be or--ed with type to indicate * that return from function/from whole filter should be * forced. Important thing about &f_val s is that they may be copied * with simple =. That's fine for all currently defined types: strings @@ -71,8 +71,14 @@ pm_path_compare(struct f_path_mask *m1, struct f_path_mask *m2) } } -/* - * val_compare - compare two values, returns -1, 0, 1 on <, =, > and 999 on error +/** + * val_compare + * @v1: first value + * @v2: second value + * + * Compares two values and returns -1, 0, 1 on <, =, > or 999 on error. + * Tree module relies on this giving consistent results so that it can + * build balanced trees. */ int val_compare(struct f_val v1, struct f_val v2) @@ -140,8 +146,13 @@ val_simple_in_range(struct f_val v1, struct f_val v2) return CMP_ERROR; } -/* - * val_in_range - check if @v1 ~ @v2 +/** + * val_in_range + * @v1: element + * @v2: set + * + * Checks if @v1 is element (|~| operator) of @v2. Sets are internally represented as balanced trees, see + * tree.c module (this is not limited to sets, but for non-set cases, val_simple_in_range() is called early). */ int val_in_range(struct f_val v1, struct f_val v2) -- cgit v1.2.3