doxygen: Add some missing documentation.

[paraslash.git] / recv.h

diff --git a/recv.h b/recv.h
index 05c5ed7615729219990859d2f953f85b96437c0a..ee8138f9d9c12a9674600091d3073b1807dc41ba 100644 (file)
--- a/recv.h
+++ b/recv.h
@@ -50,6 +50,12 @@ struct receiver {
         * \a argc and \a argv.
         */
        void *(*parse_config)(int argc, char **argv);
+       /**
+        * Deallocate the configuration structure of a receiver node.
+        *
+        * This calls the receiver-specific cleanup function generated by
+        * gengetopt.
+        */
        void (*free_config)(void *conf);
        /**
         * Open one instance of the receiver.