summaryrefslogtreecommitdiff
path: root/include/apr_tables.h
diff options
context:
space:
mode:
authorjwoolley <jwoolley@13f79535-47bb-0310-9956-ffa450edef68>2001-07-07 02:51:43 +0000
committerjwoolley <jwoolley@13f79535-47bb-0310-9956-ffa450edef68>2001-07-07 02:51:43 +0000
commitf64dc4d2d6a3c2e3ac9f4f3785e8fa1797001b20 (patch)
tree955686e64d0981e8b1ef1309c0f69b9a1096481b /include/apr_tables.h
parent547ee86ce75a43e682896ceb9971673528083e0e (diff)
downloadlibapr-f64dc4d2d6a3c2e3ac9f4f3785e8fa1797001b20.tar.gz
Document what the function passed to apr_table_[v]do() should return
to indicate whether iteration should continue. Submitted by: Joe Orton <jorton@redhat.com> Reviewed by: Cliff Woolley git-svn-id: http://svn.apache.org/repos/asf/apr/apr/trunk@61879 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'include/apr_tables.h')
-rw-r--r--include/apr_tables.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/include/apr_tables.h b/include/apr_tables.h
index fcb2a4463..db2c1be37 100644
--- a/include/apr_tables.h
+++ b/include/apr_tables.h
@@ -366,7 +366,7 @@ APR_DECLARE(apr_table_t *) apr_table_overlay(apr_pool_t *p,
* element in the table. If there is data passed in as a vararg, then the
* function is only run on those element's whose key matches something in
* the vararg. If the vararg is NULL, then every element is run through the
- * function.
+ * function. Iteration continues while the function returns non-zero.
* @param comp The function to run
* @param rec The data to pass as the first argument to the function
* @param t The table to iterate over
@@ -383,7 +383,7 @@ APR_DECLARE_NONSTD(void) apr_table_do(int (*comp)(void *, const char *, const ch
* element in the table. If there is data passed in as a vararg, then the
* function is only run on those element's whose key matches something in
* the vararg. If the vararg is NULL, then every element is run through the
- * function.
+ * function. Iteration continues while the function returns non-zero.
* @param comp The function to run
* @param rec The data to pass as the first argument to the function
* @param t The table to iterate over