svn commit: r988068 - in /subversion/trunk/subversion/libsvn_ra_neon: ra_neon.h util.c

[ju...@apache.org]

Author: julianfoad
Date: Mon Aug 23 10:40:16 2010
New Revision: 988068

URL: http://svn.apache.org/viewvc?rev=988068&view=rev
Log:
Add more comments to ra_neon functions.  A follow-up to r987592.

* subversion/libsvn_ra_neon/ra_neon.h
  (svn_ra_neon__xml_parser_create): Say how the created parser is returned.

* subversion/libsvn_ra_neon/util.c
  (multistatus_parser_create): Add a comment.
  (attach_ne_body_reader): Add a doc string.

Modified:
    subversion/trunk/subversion/libsvn_ra_neon/ra_neon.h
    subversion/trunk/subversion/libsvn_ra_neon/util.c

Modified: subversion/trunk/subversion/libsvn_ra_neon/ra_neon.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/libsvn_ra_neon/ra_neon.h?rev=988068&r1=988067&r2=988068&view=diff
==============================================================================
--- subversion/trunk/subversion/libsvn_ra_neon/ra_neon.h (original)
+++ subversion/trunk/subversion/libsvn_ra_neon/ra_neon.h Mon Aug 23 10:40:16 2010
@@ -675,7 +675,8 @@ typedef svn_error_t * (*svn_ra_neon__end
  * Register a pool cleanup on the pool of REQ to clean up any allocated
  * Neon resources.
  *
- * ACCPT indicates whether the parser wants read the response body
+ * Return the new parser.  Also attach it to REQ if ACCPT is non-null.
+ * ACCPT indicates whether the parser wants to read the response body
  * or not.  Pass NULL for ACCPT when you don't want the returned parser
  * to be attached to REQ.
  */

Modified: subversion/trunk/subversion/libsvn_ra_neon/util.c
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/libsvn_ra_neon/util.c?rev=988068&r1=988067&r2=988068&view=diff
==============================================================================
--- subversion/trunk/subversion/libsvn_ra_neon/util.c (original)
+++ subversion/trunk/subversion/libsvn_ra_neon/util.c Mon Aug 23 10:40:16 2010
@@ -299,6 +299,7 @@ multistatus_parser_create(svn_ra_neon__r
 {
   multistatus_baton_t *b = apr_pcalloc(req->pool, sizeof(*b));
 
+  /* Create a parser, attached to REQ. (Ignore the return value.) */
   svn_ra_neon__xml_parser_create(req, ne_accept_207,
                                  start_207_element,
                                  svn_ra_neon__xml_collect_cdata,
@@ -426,6 +427,10 @@ compressed_body_reader_cleanup(void *bat
   return APR_SUCCESS;
 }
 
+/* Attach READER as a response reader for the request REQ, with the
+ * acceptance function ACCPT.  The response body data will be decompressed,
+ * if compressed, before being passed to READER.  USERDATA will be passed as
+ * the first argument to the acceptance and reader callbacks. */
 static void
 attach_ne_body_reader(svn_ra_neon__request_t *req,
                       ne_accept_response accpt,