subversion-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gst...@apache.org
Subject svn commit: r1349736 - /subversion/trunk/subversion/libsvn_ra_serf/ra_serf.h
Date Wed, 13 Jun 2012 10:31:53 GMT
Author: gstein
Date: Wed Jun 13 10:31:53 2012
New Revision: 1349736

URL: http://svn.apache.org/viewvc?rev=1349736&view=rev
Log:
Add documentation.

* subversion/libsvn_ra_serf/ra_serf.h:
  (svn_ra_serf__xml_context_create): add docco

Modified:
    subversion/trunk/subversion/libsvn_ra_serf/ra_serf.h

Modified: subversion/trunk/subversion/libsvn_ra_serf/ra_serf.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/libsvn_ra_serf/ra_serf.h?rev=1349736&r1=1349735&r2=1349736&view=diff
==============================================================================
--- subversion/trunk/subversion/libsvn_ra_serf/ra_serf.h (original)
+++ subversion/trunk/subversion/libsvn_ra_serf/ra_serf.h Wed Jun 13 10:31:53 2012
@@ -708,7 +708,22 @@ typedef struct svn_ra_serf__xml_transiti
 } svn_ra_serf__xml_transition_t;
 
 
-/* ### docco  */
+/* Construct an XML parsing context, based on the TTABLE transition table.
+   As content is parsed, the CLOSED_CB callback will be invoked according
+   to the definition in the table.
+
+   If OPENED_CB is not NULL, then it will be invoked for *every* tag-open
+   event. The callback will need to use the ENTERED_STATE and TAG parameters
+   to decide what it would like to do.
+
+   If CDATA_CB is not NULL, then it will be called for all cdata that is
+   not be automatically collected (based on the transition table record's
+   COLLECT_CDATA flag). It will be called in every state, so the callback
+   must examine the CURRENT_STATE parameter to decide what to do.
+
+   The same BATON value will be passed to all three callbacks.
+
+   The context will be created within RESULT_POOL.  */
 svn_ra_serf__xml_context_t *
 svn_ra_serf__xml_context_create(
   const svn_ra_serf__xml_transition_t *ttable,



Mime
View raw message