Merge branch 'refs/heads/t/doxygen'

[paraslash.git] / aft.c

diff --git a/aft.c b/aft.c
index d58f9daf014c0237148db3e0837f11f003bd0230..c2642ed3d13ceb139335cdef0c06c6999cd2ae7b 100644 (file)
--- a/aft.c
+++ b/aft.c
@@ -377,6 +377,7 @@ static void save_afhi(struct afh_info *afhi, char *buf)
        sprintf(p, "%s", afhi->tags.comment);
 }
 
+/* does not load the chunk table */
 static void load_afhi(const char *buf, struct afh_info *afhi)
 {
        afhi->seconds_total = read_u32(buf + AFHI_SECONDS_TOTAL_OFFSET);
@@ -592,6 +593,10 @@ static int get_hash_of_row(const struct osl_row *row, unsigned char **hash)
  * \param afhi Result pointer.
  *
  * \return The return value of the underlying call to osl_get_object().
+ *
+ * After the call the members of the afhi structure point to mapped memory
+ * which is owned by the osl table, Hence the caller must not attempt to free
+ * this memory by calling \ref clear_afhi().
  */
 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi)
 {