From: Andre Noll <maan@systemlinux.org>
Date: Thu, 14 Jan 2010 22:49:57 +0000 (+0100)
Subject: filter.h: Document that the ->close method need not be provided.
X-Git-Tag: v0.4.2~97
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=4ba472b7148a36788b9b86702a3828b189c7c2ac;p=paraslash.git

filter.h: Document that the ->close method need not be provided.
---

diff --git a/filter.h b/filter.h
index 2c1fdac1..a11cad50 100644
--- 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);
 	/**