aft: Add documentation of free_status_items().
authorAndre Noll <maan@tuebingen.mpg.de>
Fri, 7 Sep 2018 10:41:11 +0000 (12:41 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Wed, 19 Sep 2018 18:42:39 +0000 (20:42 +0200)
It's a public function and thus should get doxygen comments.

aft.c

diff --git a/aft.c b/aft.c
index 5d4e647..0544091 100644 (file)
--- 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);