From: Andre Noll <maan@systemlinux.org>
Date: Thu, 3 Jul 2014 21:30:58 +0000 (+0200)
Subject: afh_common: Improve documentation of clear_afh().
X-Git-Tag: v0.5.3~7
X-Git-Url: http://git.tuebingen.mpg.de/?a=commitdiff_plain;h=8005b324b956c7d462a7b68fc262b49843e61fb0;hp=8aa9d0cddfefb882cfd8e7cadbeea5cce31b731f;p=paraslash.git

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.
---

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)
 {