From 03395f78c92158d93dc122fa5223149e706d80f6 Mon Sep 17 00:00:00 2001 From: Michael Beck Date: Mon, 29 Nov 2004 13:12:43 +0000 Subject: [PATCH] More doxygen docu [r4493] --- ir/adt/pset.h | 11 ++++++++--- ir/adt/set.h | 11 ++++++++++- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/ir/adt/pset.h b/ir/adt/pset.h index 059005f53..f32095b7b 100644 --- a/ir/adt/pset.h +++ b/ir/adt/pset.h @@ -182,10 +182,15 @@ void pset_stats (pset *pset); #ifdef DEBUG /** - * Describe a set by printing all elements - * to stdout. + * Describe a pset. + * + * Writes a description of a set to stdout. The description includes: + * - a header telling how many elements (nkey) and segments (nseg) are in use + * - for every collision chain the number of element with its hash values + * + * @param pset the pset */ -void pset_describe (pset *); +void pset_describe (pset *pset); #endif /* @@@ NYI */ diff --git a/ir/adt/set.h b/ir/adt/set.h index 9d924f907..8b95c0c0e 100644 --- a/ir/adt/set.h +++ b/ir/adt/set.h @@ -197,7 +197,16 @@ void set_stats (set *set); #endif #ifdef DEBUG -void set_describe (set *); +/** + * Describe a set. + * + * Writes a description of a set to stdout. The description includes: + * - a header telling how many elements (nkey) and segments (nseg) are in use + * - for every collision chain the number of element with its hash values + * + * @param set the set + */ +void set_describe (set *set); #endif -- 2.20.1