Comments like this help keep the sanity of module authors.

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@93783 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/include/util_filter.h b/include/util_filter.h
index 8a66a47227188f10dbfce01d7eccaa57229e64cb..c4950ffb3ba0cf74b13c7338d0d15b1260ec63a2 100644 (file)
--- a/include/util_filter.h
+++ b/include/util_filter.h
@@ -282,6 +282,7 @@ struct ap_filter_t {
  * Get the current bucket brigade from the next filter on the filter
  * stack.  The filter returns an apr_status_t value.  If the bottom-most 
  * filter doesn't read from the network, then ::AP_NOBODY_READ is returned.
+ * The bucket brigade will be empty when there is nothing left to get.
  * @param filter The next filter in the chain
  * @param bucket The current bucket brigade
  * @param mode   The way in which the data should be read