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 cad972d94026eb1f1587fdf7201b752786b801b7..b3ba348526cad86c103bcff65e3765fc3b571e2a 100644 (file)
--- 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)
 {