From: Andre Noll <maan@tuebingen.mpg.de>
Date: Fri, 7 Sep 2018 10:41:11 +0000 (+0200)
Subject: aft: Add documentation of free_status_items().
X-Git-Tag: v0.6.3~72
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=9c9d3e49b2f17e5a83b44b009785b9b6dd5b95aa;p=paraslash.git

aft: Add documentation of free_status_items().

It's a public function and thus should get doxygen comments.
---

diff --git a/aft.c b/aft.c
index 5d4e6477..0544091b 100644
--- a/aft.c
+++ b/aft.c
@@ -983,6 +983,11 @@ out:
 	WRITE_STATUS_ITEM(pb, SI_file_size, "%ld\n", statbuf.st_size / 1024);
 }
 
+/**
+ * Deallocate and invalidate the status item strings.
+ *
+ * This needs to be a public function so that afs.c can call it on shutdown.
+ */
 void free_status_items(void)
 {
 	freep(&status_items);