filter.h: Document that the ->close method need not be provided.
authorAndre Noll <maan@systemlinux.org>
Thu, 14 Jan 2010 22:49:57 +0000 (23:49 +0100)
committerAndre Noll <maan@systemlinux.org>
Thu, 14 Jan 2010 22:49:57 +0000 (23:49 +0100)
filter.h

index 2c1fdac..a11cad5 100644 (file)
--- a/filter.h
+++ b/filter.h
@@ -64,7 +64,8 @@ struct filter {
         * Close one instance of this filter.
         *
         * Free all resources of associated with \a fn that were previously allocated
-        * by the open() function.
+        * by the open() function. It's OK to leave this alone if the filter does not
+        * need any cleanups.
         */
        void (*close)(struct filter_node *fn);
        /**