afh_common: Improve documentation of clear_afh().

[paraslash.git] / afh_common.c

diff --git a/afh_common.c b/afh_common.c
index 5be43550c202b516aaedf332dbbfba341da20dcb..b3ba348526cad86c103bcff65e3765fc3b571e2a 100644 (file)
--- a/afh_common.c
+++ b/afh_common.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1997-2013 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 1997-2014 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -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)
 {