You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@apr.apache.org by sf...@apache.org on 2012/01/22 11:12:07 UTC

svn commit: r1234474 - /apr/apr/trunk/include/apr_buckets.h

Author: sf
Date: Sun Jan 22 10:12:07 2012
New Revision: 1234474

URL: http://svn.apache.org/viewvc?rev=1234474&view=rev
Log:
Clarify docs

Modified:
    apr/apr/trunk/include/apr_buckets.h

Modified: apr/apr/trunk/include/apr_buckets.h
URL: http://svn.apache.org/viewvc/apr/apr/trunk/include/apr_buckets.h?rev=1234474&r1=1234473&r2=1234474&view=diff
==============================================================================
--- apr/apr/trunk/include/apr_buckets.h (original)
+++ apr/apr/trunk/include/apr_buckets.h Sun Jan 22 10:12:07 2012
@@ -693,7 +693,8 @@ APR_DECLARE(apr_status_t) apr_brigade_cl
  * @param b The brigade to split
  * @param e The first bucket to move
  * @param a The brigade which should be used for the result or NULL if
- *          a new brigade should be created.
+ *          a new brigade should be created. The brigade @param a will be
+ *          cleared if it is not empty.
  * @return The brigade supplied in @param a or a new one if @param a was NULL.
  * @warning Note that this function allocates a new brigade if @param a is
  * NULL so memory consumption should be carefully considered.