aft: Add documentation of free_status_items().

[paraslash.git] / aft.c

diff --git a/aft.c b/aft.c
index 5d4e64773e8a7e7011ef88bb69771a21bd285a1b..0544091bdba4e5054b120e24322504f56e38df4f 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);