From 8005b324b956c7d462a7b68fc262b49843e61fb0 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Thu, 3 Jul 2014 23:30:58 +0200 Subject: [PATCH] afh_common: Improve documentation of clear_afh(). The doxygen comment for this public function was rather bad. This commit changes the comment to clarify that the function does not free the given afhi structure but only its contents. --- afh_common.c | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/afh_common.c b/afh_common.c index cad972d9..b3ba3485 100644 --- a/afh_common.c +++ b/afh_common.c @@ -230,11 +230,12 @@ success: } /** - * Deallocate contents of a filled-in ahi structure + * Deallocate the contents of an afh_info structure. * * \param afhi The structure to clear. * - * The given pointer is kept, everything else is freed. + * This only frees the memory the various pointer fields of \a afhi point to. + * It does *not* free \a afhi itself. */ void clear_afhi(struct afh_info *afhi) { -- 2.39.2